nextcloud / nextcloud/cookbook

Add permanent navigation bar to documentation pages

Open
#1,748 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation enhancement
Dominant language
HTML
Stars
641
Forks
113
Avg merge
21h 31m
Merged PRs (30d)
26

Description

Hey,

Is your feature request related to a problem? Please describe.
I noticed when reading the documentation that when you want to switch the section (e.g. from the setup page to the user section) you have to return with the "back" button/shortcut to the main page before you can switch. There are no direct links to the sections and also there is no link to "home".

Describe the solution you'd like
One idea would be to have a permanent navigation bar on the top providing links to the main page as well as the user / developer / admin sections. That would make it easier to navigate in the documentation.

Describe alternatives you've considered

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the documentation pages linked in the issue, including the setup, user, and main pages, to identify how navigation is currently provided. Add a persistent link set for home and the user, developer, and admin sections, then verify that visitors can switch sections directly from each documentation page.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
documentation
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.