Skip to content

Commit

Permalink
Remove the "index" tentative fix
Browse files Browse the repository at this point in the history
It's not possible to reference the package main page and this cannot be
fixed now by tweaking the convention.
  • Loading branch information
Julow authored and jonludlam committed Nov 29, 2023
1 parent 0dcfba6 commit b99d61c
Showing 1 changed file with 2 additions and 6 deletions.
8 changes: 2 additions & 6 deletions doc/parent_child_spec.mld
Original file line number Diff line number Diff line change
Expand Up @@ -180,12 +180,8 @@ following convention should be followed.
- A page is the parent of every installed pages. The driver can freely name this
page, for example it can be named after the package. In what follows, we
refer to this page as the [pkg] page.
- If there is an installed [index.mld] file:
+ The driver has to use it as content for the [pkg] page.
+ The can decide to also include a [index] page as child of the [pkg] page.
- If it does not, then some references to the [index] page might be
unresolved.
- If it does, it will create a warning.
- If there is an installed [index.mld] file, the driver has to use it as
content for the [pkg] page.
- If there is no installed [index.mld] page, the driver has to generate some
content for the [pkg] page.

Expand Down

0 comments on commit b99d61c

Please sign in to comment.