docs/ mixes both conventions:
getting-started.md architecture.md
getting_started_extended.md architecture_detailed.md
custom_adapters_tutorial.md developer_setup.md
API-reference.md TROUBLESHOOTING.md
Four snake_case, two kebab-case, one SCREAMING. getting-started.md and
getting_started_extended.md sitting next to each other is the clearest symptom — you cannot guess
either filename from the other.
Low severity, but it makes docs hard to link and hard to find, and it gets more expensive to fix the
longer it's left (every rename is a potential broken inbound link).
Fix: settle on kebab-case for docs pages and do a single rename pass, updating internal links and
mkdocs.yml nav in the same commit. If any of these are linked externally, keep a redirect or a stub.
Best done as one atomic PR rather than drifting, and best done while the docs set is still small.
docs/mixes both conventions:Four snake_case, two kebab-case, one SCREAMING.
getting-started.mdandgetting_started_extended.mdsitting next to each other is the clearest symptom — you cannot guesseither filename from the other.
Low severity, but it makes docs hard to link and hard to find, and it gets more expensive to fix the
longer it's left (every rename is a potential broken inbound link).
Fix: settle on kebab-case for docs pages and do a single rename pass, updating internal links and
mkdocs.ymlnav in the same commit. If any of these are linked externally, keep a redirect or a stub.Best done as one atomic PR rather than drifting, and best done while the docs set is still small.