Skip to content

clean up config formatting and simplify inline comments#5758

Open
kazisufiyan-k2 wants to merge 1 commit intoaws:mainfrom
kazisufiyan-k2:patch-2
Open

clean up config formatting and simplify inline comments#5758
kazisufiyan-k2 wants to merge 1 commit intoaws:mainfrom
kazisufiyan-k2:patch-2

Conversation

@kazisufiyan-k2
Copy link
Copy Markdown

Purpose

Clean up docs/mkdocs.yml formatting and simplify inline comments for
better readability and maintainability.

No functional changes — formatting and documentation only

Test Plan

No testing required — documentation-only change with no functional
impact on the site build or output.

Test Result

N/A

- Remove verbose section header dividers and replace with minimal
  inline comments only where context adds value
- Remove duplicate comments that simply restated the key name
- Add missing accent: custom to dark mode palette to match light mode
- Group markdown extensions in logical order: basic, admonitions,
  code, tabs, and toc
- Group theme features into code, navigation, search, and toc sections
  with a single inline comment per feature explaining its purpose
- Fix inconsistent blank lines between palette, features, and icon
  sections for consistent readability

No functional changes — formatting and documentation only
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant