Doc by AI: Master issue: complete the user documentation of the website written by AI #921

Goal

Complete the feature "user documentation of the website written by AI". At the end, one command keeps the documentation pages in documentation up to date, and no person writes a documentation page by hand.

This issue is the master issue of the feature. It links all the issues of the feature and gives the order of the work.

What is done

These closed issues made the experiment and the tool:

• Preserve the AI documentation experiment in an isolated repository folder #407

• Document the AI documentation process and provide a generate-and-build tool #501

• Installation: Remove the old local Heidrun application after the documentation experiment #391

• The experiment is in web_doc_by_ai, limited to the Files sidebar. The state of the experiment is in HANDOFF.md.

• The process is explained in documentation_by_ai.

• The tool is in documentation_by_ai, with the command pnpm docs:generate-and-build.

• Nobody has run a real model generation and website build with pnpm docs:generate-and-build yet.

Plan

Step 1: prove that the generation works end to end

Run pnpm docs:generate-and-build once with a real model, on one page only. The run must make the page and build the website. Keep the prompt, the answer, the settings, the cost, and the build output. If the run fails, fix the tool before step 2.

Step 2: fix the Files sidebar pages and check the judge

This issue holds the work:

• Continue the Files sidebar AI documentation experiment #409

• The generator fixes the two known defects: the relative path starts at the Git repository root, and the user must click a new workspace after adding it.

• The calibrated judge checks the four Files sidebar pages, with the fixed rubric.

• The fixed tasks are checked in the real application, started with --no-splash-screen.

Step 3: the command that updates all the documentation

This issue holds the work:

• Generate the user documentation of the website with AI, from the last documented commit to the current commit #375

• Build pnpm docs:update_by_ai on top of pnpm docs:generate-and-build.

• Add the file .last_documented_commit and the four tests of the issue.

• Answer the three open questions of the issue before the work starts.

• The issue names the file docs/agents_rules/glossary.md. The glossary is now the folder glossary. Update the issue.

Done when

• The three steps are done, and their issues are closed.
• The developer runs pnpm docs:update_by_ai, reads the pull request, and merges it, and the website shows the updated documentation.