docs: drop legacy-html from handbook URLs - #120
Conversation
Imported manuals live under user-guide/chapters/; overview moves to user-guide/overview.md (was legacy-html-manuals.md). prepare_docs.py, mkdocs nav, and cross-links updated. Gitignore chapters/ build output.
Address PR rsyslog#120 review: removing legacy-html/ and legacy-html-manuals.md should not depend on doc/*.html being present so partial checkouts or missing doc/ still drop stale output. Co-authored-by: Cursor <cursoragent@cursor.com>
|
@cubic-dev-ai review |
@alorbach I have started the AI code review. It will take a few minutes to complete. |
Respond to PR rsyslog#120 review: YAML keys for user guide nav use _yaml_single_quoted labels; pre-migration artifacts removed via a small loop that handles dir-or-file per path (Gemini code assist). Co-authored-by: Cursor <cursoragent@cursor.com>
|
@cubic-dev-ai review |
@alorbach I have started the AI code review. It will take a few minutes to complete. |
There was a problem hiding this comment.
Code Review
This pull request restructures the documentation site by migrating legacy HTML manuals from legacy-html/ to a new user-guide/chapters/ directory and renaming the overview page. The prepare_docs.py script has been updated to support this new layout, including logic to remove old artifacts, and all internal links and the MkDocs configuration have been adjusted. Feedback suggests adding the generated overview.md file to .gitignore to prevent tracking generated documentation.
Imported manuals live under user-guide/chapters/; overview moves to user-guide/overview.md (was legacy-html-manuals.md). prepare_docs.py, mkdocs nav, and cross-links updated. Gitignore chapters/ build output.