Skip to content

docs: drop legacy-html from handbook URLs - #120

Merged
alorbach merged 3 commits into
rsyslog:masterfrom
alorbach:doc/fixlinks
May 4, 2026
Merged

docs: drop legacy-html from handbook URLs#120
alorbach merged 3 commits into
rsyslog:masterfrom
alorbach:doc/fixlinks

Conversation

@alorbach

@alorbach alorbach commented May 4, 2026

Copy link
Copy Markdown
Member

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.

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.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 7 files

gemini-code-assist[bot]

This comment was marked as outdated.

gemini-code-assist[bot]

This comment was marked as outdated.

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>
@alorbach

alorbach commented May 4, 2026

Copy link
Copy Markdown
Member Author

@cubic-dev-ai review
@gemini review

@cubic-dev-ai

cubic-dev-ai Bot commented May 4, 2026

Copy link
Copy Markdown

@cubic-dev-ai review
@gemini review

@alorbach I have started the AI code review. It will take a few minutes to complete.

gemini-code-assist[bot]

This comment was marked as outdated.

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>
@alorbach

alorbach commented May 4, 2026

Copy link
Copy Markdown
Member Author

@cubic-dev-ai review
@gemini review

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 7 files

@cubic-dev-ai

cubic-dev-ai Bot commented May 4, 2026

Copy link
Copy Markdown

@cubic-dev-ai review
@gemini review

@alorbach I have started the AI code review. It will take a few minutes to complete.

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread .gitignore

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 7 files

@alorbach
alorbach merged commit a1627ce into rsyslog:master May 4, 2026
6 checks passed
@alorbach
alorbach deleted the doc/fixlinks branch May 4, 2026 13:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant