Skip to content

Normalize wiki Markdown structure - #8

Merged
BenCodez merged 5 commits into
mainfrom
agent/wiki-markdown-cleanup
Aug 2, 2026
Merged

Normalize wiki Markdown structure#8
BenCodez merged 5 commits into
mainfrom
agent/wiki-markdown-cleanup

Conversation

@BenCodez

Copy link
Copy Markdown
Owner

What changed

  • add a single page-level H1 to documentation pages that relied only on front matter
  • normalize nested heading levels in the broadcast, logging, milestone, streak, and VoteShop guides
  • remove eight accidental citation tokens from AdvancedPriority-Rewards.md
  • correct confirmed spelling and grammar mistakes in commands, proxy guides, reward examples, and related pages
  • add missing final newlines
  • improve the short Bedrock heading/configuration example

Why

Wiki.js front matter hides several structural problems that become visible in repository, GitHub Wiki, accessibility, and generated-site contexts. Consistent heading hierarchy also makes long pages easier to navigate and parse.

The API and Special Rewards pages are intentionally excluded here because pull request #7 rewrites them and supplies their corrected H1 structure.

Validation

  • git diff --check passed locally
  • verified the cleanup plus pull request Correct current VotingPlugin documentation #7 content produces exactly one H1 on every content page
  • verified the combined page set has no missing GitHub Wiki targets
  • confirmed the known spelling patterns and accidental citation markers no longer remain

AI disclosure: This pull request was created by ChatGPT/Codex at the maintainer's request. The mechanical and prose cleanup should still receive normal maintainer review before merge.

@BenCodez
BenCodez marked this pull request as ready for review August 2, 2026 04:12

@chatgpt-codex-connector chatgpt-codex-connector 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 0a0a2be049

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread VotingPlugin/VoteMilestones.md Outdated
---

## Where VoteMilestones are configured
### Where VoteMilestones are configured

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Restore level-two milestone sections

Promote the page-level sections back to ##: the page now jumps directly from its H1 to this H3, and the same blanket demotion later makes Legacy migration and Placeholders children of the Examples section. This produces an inaccurate document outline and generated table of contents for navigation and screen-reader users; only actual subsections such as individual examples should remain at H3.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

Addressed in 3afbe63: the page-level VoteMilestones sections, including Legacy migration and Placeholders, are restored to H2 while individual examples remain H3.

Comment thread VotingPlugin/VoteStreak-System.md Outdated
---

## Location
### Location

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Promote Location to a level-two heading

Change Location back to ## Location. It is a standalone page section immediately beneath the H1, so demoting it to H3 creates an H1-to-H3 level skip before the later H2 sections and leaves the generated outline structurally inconsistent.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

Addressed in f904cf8: Location is restored to an H2 section.

BenCodez commented Aug 2, 2026

Copy link
Copy Markdown
Owner Author

@codex review

The two previous heading findings were addressed in 3afbe63 and f904cf8. Please review the current head.

@chatgpt-codex-connector chatgpt-codex-connector 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.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: f904cf8ccc

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread VotingPlugin/Rewards.md
dateCreated: 2025-08-30T22:18:22.882Z
---

# Rewards

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Promote the introductory Rewards headings

Adding this page title leaves the document jumping directly from H1 to the H3 headings at lines 13, 21, and 36, even though these introduce top-level sections before the later H2 sections. This produces an inconsistent generated outline for navigation and screen-reader users; promote those introductory sections to H2 (and remove the empty H2 at line 64) so their subsections can remain beneath them.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

Addressed in f1dbd22: the three introductory sections are now H2, the empty H2 was removed, and Placeholders is an H2 so it is not incorrectly nested under reward-file listing.

BenCodez commented Aug 2, 2026

Copy link
Copy Markdown
Owner Author

@codex review

The latest Rewards.md outline finding was addressed in f1dbd22. Please review the current head.

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Keep it up!

Reviewed commit: f1dbd22ee6

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@BenCodez
BenCodez merged commit 7bb1ec9 into main Aug 2, 2026
@BenCodez
BenCodez deleted the agent/wiki-markdown-cleanup branch August 2, 2026 16:05
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