@doc-new's index.html might be missing a link to `/local/index.html`
Nobody has claimed this yet.
- Dominant language
- OCaml
- Stars
- 1.9k
- Forks
- 500
- Avg merge
- 15h 21m
- Merged PRs (30d)
- 277
Description
I've been testing @doc-new with dune.3.13.0~alpha1 internally. Things look pretty good in general. One thing which was noticed is that there are no links to /local/index.html from /index.html. It slighly breaks up/down navigation.
On /index.html, click on a subindex foo. It leads to /local/foo/index.html. There the breadcrumps at the top of the page shows Up – docs » local » foo instead of just Up – docs » aa_be. So clicking on up doesn't bring us back to /index.html.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the navigation with @doc-new and dune.3.13.0~alpha1: open /index.html, follow a subindex such as /local/foo/index.html, and test the Up breadcrumb. Inspect how these pages are generated and linked. Done means the generated /local/index.html is linked from /index.html and Up returns to the root page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ocaml
- Domain
- build-system, documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100