nextcloud / nextcloud/server

Customize Help/Documentation

Open
#58,909 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

0. Needs triage enhancement feature: theming
Dominant language
PHP
Stars
36.9k
Forks
5.2k
Avg merge
2d 3h
Merged PRs (30d)
713

Description

[!TIP]

Help move this idea forward
  • Use the 👍 reaction to show support for this feature.
  • Avoid commenting unless you have relevant information to add; unnecessary comments create noise for subscribers.
  • Subscribe to receive notifications about status changes and new comments.

Is your feature request related to a problem? Please describe.
I would like to customize the documentation that appears when clicking on the "help" button of the user menu (which redirects to https://the-domain/settings/help)

Describe the solution you'd like

I tried the solution suggested in https://help.nextcloud.com/t/custom-help-link-to-a-specific-documentation/54855 that proposes to replace the /core/doc/ folder.
It works well for the documentation, but then I'm faced with integrity errors.

Describe alternatives you've considered

I could disable the integrity check, but I don't think this is a good practice.

One of the following solution would be nice :

Additional context

Thank you for all the work 👐

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 tracing the user-menu Help link to /settings/help and reviewing the current /core/doc/ path and integrity-check behavior. Compare the two proposed directions—an excluded folder or a configurable documentation path—and define tests showing that customized documentation works without integrity errors.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.