Docs: Clean up directory paths in docs
Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.
Problem to solve
It seems we have a lot of links with paths that travel too far, such that they "travel" right out of the directory then back in. For example:
- File:
doc/administration/dedicated/architecture.md - Link:
For more information, see [Geo](../../administration/geo/index.md) - Correct link:
For more information, see [Geo](../geo/index.md).
We should clean this up, to keep paths as simple and clear as possible. It also helps future maintenance if we need to batch move or rename files (which is what I was doing when I ran into this).
Phase 1: Rule to catch single level nesting issues ✅
After we fix these violations across all projects, we need to enforce them. New rule for markdownlint added in: Add link path test to markdownlint (!185086 - merged)
We've cleaned up all files that violated this initial rules, for example:
- Fixing unnecessary link paths (!185488 - merged) (and similar, see issue list below).
Phase 2: Rule to catch any level of nesting
The first MVC version does not work for any level of nesting. We should either update, or rewrite, the current rule so that it works for all cases.
Here's a POC of how it should work, though I'm not sure about the quality of that code so we should probably start from scratch: !187693 (closed)
Example of the issue it needs to catch: