From 7269998b143ce88683356aa07a2c15da15fc9efc Mon Sep 17 00:00:00 2001 From: "philip.cline" Date: Mon, 11 Dec 2023 10:58:26 -0500 Subject: [PATCH] refactor(docs): add missing files to nav --- docs/dev/api_interaction.md | 2 +- docs/dev/localization.md | 2 +- mkdocs.yml | 2 ++ 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/dev/api_interaction.md b/docs/dev/api_interaction.md index 75537569b..2916742c7 100644 --- a/docs/dev/api_interaction.md +++ b/docs/dev/api_interaction.md @@ -1,4 +1,4 @@ -# API Interaction Transcript +# API Interaction The following is a set of instructions on API calls needed to upload and validate a feed, wait for the tasks' completion, and then browse its contents. All of the endpoints needed to load and process a GTFS file are REST-based. The endpoints diff --git a/docs/dev/localization.md b/docs/dev/localization.md index 9d15e785c..49f385314 100644 --- a/docs/dev/localization.md +++ b/docs/dev/localization.md @@ -3,7 +3,7 @@ ## Adding translations for a new language To add support for a new language, you need to perform the following steps: -1. Create a new language file in folder `i18`, e.g. by copying the `english.yml`. +1. Create a new language file in folder `i18n`, e.g. by copying the `english.yml` file. 2. In the newly created `.yml`, adapt the first two lines: `_id` should conform to the ISO 639 language code, `_name` to the localized language name. 3. In `lib/common/util/config.js`, add the import of the new language file at the mark `// Add additional language files here.` Mind to add an `// $FlowFixMe` hint before the new line to make the linter happy 4. Translate all messages in the `.yml` file. Note, that names surrounded by percent characters (`%`) denote parameters and must not be translated. diff --git a/mkdocs.yml b/mkdocs.yml index c8a8d02eb..87ee85f78 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -28,6 +28,8 @@ nav: - Deployment: 'dev/deployment.md' - Development: 'dev/development.md' - Migration: 'dev/migration.md' + - Localization: 'dev/localization.md' + - API Interaction: 'dev/api_interaction.md' - Appendices: - GTFS Validation Warnings: 'user/appendix-gtfs-warnings.md'