Skip to content

Decouple parent from page name #171

Open
@TRSx80

Description

@TRSx80

Currently, each page follows a naming convention, like:

Parent-Topic-Name_Child-Topic-Name.md

  1. Is there something in mkdocs which requires this to function properly, or is this simply some arbitrary convention someone decided on at some point?

Because it seems to me that mkdocs.yaml is the correct place to link pages with their parents.

The problem is, we currently have a number of pages which I think no longer match their parent. For just a couple examples:

  • We claim to be a build system, but building is under Development (I think it should be under User Guide, if we are being consistent, or perhaps a new section).
  • FEL boot (and maybe others) should be moved to Archive / deprecated section
  • maybe others

But above specifics are not the point of this issue, just examples.

If pages were not coupled to their parents (in the file name) I think we can move them around in mkdocs.yaml to new parents whenever we want without breaking links.

Of course I will figure out some way to keep the old links alongside, so as not to break them. Which is another implementation detail to be decided after the main part of this topic (the numbered question, above).

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions