Docs

Docs

What this screen is for

Docs is the documentation built from your repositories and served inside Fenwave, next to the component it describes. Documentation that lives with the code stays closer to the truth than documentation that lives in a wiki.

The pages you are reading now are served this way.

Before you start

To do this You need
Read documentation techdocs.read

A component’s documentation comes from its own repository. If it has none, the Docs tab is empty — a content gap, not a fault.

Opening it

  1. Explore › Docs in the sidebar for everything.
  2. Or open a component in the Catalog and use its Docs tab.

Direct URL: /docs

The interface

📸 Screenshot Placeholder: A documentation page open in the reader. Mark: (1) the documentation list, (2) the in-page navigation, (3) the language switcher, (4) search, (5) the report-issue action.

# Control What it does When you’d use it
1 Documentation list Every component with docs Browsing
2 Navigation The page tree for one set of docs Reading
3 Language switcher Switches between English and French Any bilingual doc set
4 Search Searches within the documentation Finding a specific answer
5 Report an issue Raises a problem against the page When the docs are wrong

The language switcher remembers your choice and applies it on every later page, so you set it once rather than per page.

Walkthroughs

Read a component’s documentation

Open the component in the Catalog and use its Docs tab. That route keeps you in context; going via Explore › Docs is better when you do not yet know which component you want.

Report something wrong

Use the report-issue action on the page. Documentation nobody corrects decays into something people learn to distrust, and the correction is much cheaper from the person who just hit the problem.

Scenario

The documentation you need does not exist.

  1. Explore › Docs — confirm it is genuinely absent rather than filed somewhere unexpected. Search before concluding.
  2. Open the component in the Catalog and check its Docs tab. Empty there means the repository has no documentation.
  3. Find the owner on the entity page. They are the ones who can add it.
  4. If the docs exist but are wrong rather than missing, use report-issue instead — that is a much smaller ask and far more likely to be acted on.
  5. If you own the component, documentation is added to its repository and built from there. Where it lives is the point: a page next to the code is corrected by whoever changes the code.

When it doesn’t work

Symptom Cause How to check Fix
Docs is not in the submenu Missing techdocs.read Access Explorer Ask for a role granting it
A component’s Docs tab is empty Its repository has no documentation The repository Add docs and let them build
Switching language gives a 404 The page has no counterpart in that language The other language’s tree The missing page must be written
A page is out of date Docs are built from the repository The source file’s history Correct it at source, or report the issue
Documentation is missing after a change The build has not run, or failed — Wait for the next build; then check the pipeline

Next