Where is the documentation stored?

[iach526526]

I'd like to help translate the Shield.io website, but I can't find the folder for the 'Badges' page. Where is it? Is it in the docs folder or in master/frontend?

[chris48s]

Translating the site is not really something we are looking for help with. We don't have the expertise to review or maintain translations. I posted a bit more detail about this in #10393 (comment)

---

That said, to answer your question the documentation isn't a stand-alone resource. It is quite tightly integrated with the code. Each service defines an Open API spec for itself and then the documentation is generated from those OpenAPI specs, so for example

The content on
https://shields.io/badges/npm-downloads
is generated from

shields/services/npm/npm-downloads.service.js

Lines 54 to 74 in cbedd78

	static openApi = {
	'/npm/{interval}/{packageName}': {
	get: {
	summary: 'NPM Downloads',
	parameters: pathParams(
	{
	name: 'interval',
	example: 'dw',
	description:
	'Downloads in the last Week, Month, Year, or 18 Months',
	schema: { type: 'string', enum: this.getEnum('interval') },
	},
	{
	name: 'packageName',
	example: 'localeval',
	description: packageNameDescription,
	},
	),
	},
	},
	}

The content on
https://shields.io/badges/bugzilla-bug-status
is generated from

shields/services/bugzilla/bugzilla.service.js

Lines 21 to 49 in cbedd78

	const description = `
	Use the <code>baseUrl</code> query parameter to target different Bugzilla deployments.
	If your Bugzilla badge errors, it might be because you are trying to load a private bug.
	`
	export default class Bugzilla extends BaseJsonService {
	static category = 'issue-tracking'
	static route = { base: 'bugzilla', pattern: ':bugNumber', queryParamSchema }
	static openApi = {
	'/bugzilla/{bugNumber}': {
	get: {
	summary: 'Bugzilla bug status',
	description,
	parameters: [
	pathParam({
	name: 'bugNumber',
	example: '545424',
	}),
	queryParam({
	name: 'baseUrl',
	example: 'https://bugs.eclipse.org/bugs',
	description:
	'When not specified, this will default to `https://bugzilla.mozilla.org`.',
	}),
	],
	},
	},
	}

...and so on for each of the ~500 services.

[iach526526]

Oh, I understand. Synchronizing translations in future versions might be challenging, and the documentation structure could become more complex. Perhaps keeping the documentation as it is now is the better choice. Thank you for your reply.