Merge pull request #59 from openfoodfacts/fix-index-links

doc: fix index links

Author: stephanegigandet

.github/workflows/update-dev-docs.yml

@@ -197,7 +197,8 @@ jobs:
           # Change internal links from .md extension to directory format for the docs site
           # e.g., /docs/Product-Opener/dev/how-to-develop-using-docker.md -> /docs/Product-Opener/dev/how-to-develop-using-docker/
           # Works with any link ending in .md that doesn't contain :// (excludes http/https)
-          find content/docs -name "*.mdx" -exec sed -i '/:\/\//! s|\([^)]*\)\.md|\1/|g' {} \;
+          # Special handling for /index.md to end in /
+          find content/docs -name "*.mdx" -exec sed -i '/:\/\//! s|/index\.md|/|g; s|\([^)]*\)\.md|\1/|g' {} \;
           echo "Internal links fixed"
 
       - name: Copy documentation assets

content/docs/Product-Opener/(api)/index.mdx

@@ -9,10 +9,10 @@ Welcome to the Product Opener API documentation.
 
 ## Schemas
 
-- **[Schemas](schemas/schemas/)** - API schema definitions for the last version of the API
+- **[Schemas](schemas/schemas/)** - API schema definitions for the latest version of the API
 - **[API and Product Schema Change Log](../api/ref-api-and-product-schema-change-log/)** - Reference for API and product schema changes
 
 ## API Versions
 
-- **[V2 API](v2/)** - Legacy API endpoints
-- **[V3 API](v3/)** - Current API endpoints
+- **v2 API** - Legacy API endpoints
+- **v3 API** - Current API endpoints

content/docs/Product-Opener/(docs)/api/tutorial-off-api.mdx

@@ -4,7 +4,7 @@ title: "Tutorial on using the Open Food Facts API"
 
 Welcome to this tutorial on basic usage of Open Food Facts API.
 
-First, be sure to see our [Introduction to the API](./index/).
+First, be sure to see our [Introduction to the API](./).
 
 ## Scan A Product To Get Nutri-score
 

content/docs/Product-Opener/(docs)/api/tutorial-uploading-photo-to-a-product.mdx

@@ -4,7 +4,7 @@ title: "Tutorial on uploading images to the Open Food Facts API"
 
 This basic tutorial shows you how to upload an image of a product to the Open Food Facts API.
 
-Be sure to also read the [introduction to the API](./index/)
+Be sure to also read the [introduction to the API](./)
 
 ## Points to consider before uploading photos
 
@@ -43,7 +43,7 @@ Multilingual products have several photos based on the languages present on the
 The WRITE operations in the Open Food Facts API require authentication. Therefore you need a valid `user_id`^[user_id_not_email] and `password` to write the photo to 100% Real Orange Juice.
 
 > Sign up on the [Open Food Facts App](https://world.openfoodfacts.org/) to get your `user_id` and `password` if you dont have one.
-For more details, visit the : [Authentication paragraph in our introduction](../index/#authentication).
+For more details, visit the : [Authentication paragraph in our introduction](../#authentication).
 
 ^[user_id_not_email]: user_id is the username of your account. You must not use your email address.
 

content/docs/Product-Opener/(docs)/api/tutorials/adding-missing-products.mdx

@@ -13,7 +13,7 @@ If you have an app that makes POST calls and you don't want your users to authen
 - `user_id`: myappname
 - `password`: 123456
 
-* For a complete reference on AUTH, please read: [Authentication in our introduction](../index/#authentication)
+* For a complete reference on AUTH, please read: [Authentication in our introduction](../#authentication)
 
 ---
 

content/docs/Product-Opener/(docs)/dev/how-to-develop-producer-platform.mdx

@@ -37,7 +37,7 @@ Now, the public database can be accessed at `openfoodfacts.localhost`.If you nee
 
 Note that if you [use direnv](how-to-use-direnv/), the setup should work seamlessly without redefining the variables set by `setenv.sh`.
 
-An explanation of the setup can be found at [explain-pro-dev-setup.md](explain-pro-dev-setup/)
+An explanation of the setup can be found at [explain-pro-dev-setup/](explain-pro-dev-setup/)
 
 - If you want to see the state of tasks, you can run:
 

content/docs/Product-Opener/(docs)/dev/index.mdx

@@ -4,7 +4,7 @@ title: "Introduction to Product Opener developer documentation"
 
 This documentation is for developers who wants to understand technical aspects of Product Opener.
 
-To use the API, see [API Documentation](../api/index/)
+To use the API, see [API Documentation](../api/)
 
 The repository for the project is at https://github.com/openfoodfacts/openfoodfacts-server/
 

content/docs/Product-Opener/(docs)/index.mdx

@@ -6,9 +6,9 @@ Welcome to the documentation of **Product Opener**, the web server at the heart
 
 It also powers the sibling **Open \[[Beauty](https://world.openbeautyfacts.org/)|[Pet Food](https://world.openpetfoodfacts.org/)|[Products](https://world.openproductsfacts.org/)\] Facts** projects
 
-* If you want to use the API or are interested in the data, look at [API documentation](api/index/) and [Events documentation](./events/README/)
+* If you want to use the API or are interested in the data, look at [API documentation](api/) and [Events documentation](./events/README/)
 
-* If you are a developer, look at [Developer documentation](dev/index/)
+* If you are a developer, look at [Developer documentation](dev/)
 
 The repository for the project is at https://github.com/openfoodfacts/openfoodfacts-server/
 

scripts/generate-docs.mjs

@@ -172,4 +172,5 @@ execSync("find content/docs -name '*.mdx' -exec sed -i 's/^``` \\+\\(\\w\\+=.\\+
 // Change internal links from .md extension to directory format for the docs site
 // e.g., /docs/Product-Opener/dev/how-to-develop-using-docker.md -> /docs/Product-Opener/dev/how-to-develop-using-docker/
 // Works with any link ending in .md that doesn't contain :// (excludes http/https)
-execSync("find content/docs -name '*.mdx' -exec sed -i '/:\\/\\/\\//! s|\\([^)]*\\)\\.md|\\1/|g' {} \\;", { stdio: 'inherit' });
+// Special handling for /index.md to end in /
+execSync("find content/docs -name '*.mdx' -exec sed -i '/:\\/\\/\\//! s|/index\\.md|/|g; s|\\([^)]*\\)\\.md|\\1/|g' {} \\;", { stdio: 'inherit' });