Skip to content

Documentation overhaul - #167

Merged
kaburagisec merged 42 commits into
devfrom
docs/overhaul
Oct 17, 2026
Merged

kaburagisec merged 42 commits into
devfrom
docs/overhaul

Conversation

@kaburagisec

@kaburagisec kaburagisec commented Oct 11, 2026 •

Copy link
Copy Markdown
Collaborator

Overhauling the documentation to improve readability and design aesthetics, comprising:

  1. Switching the typeface to Geist.
  2. Changing the navigation to a tab-based system.
  3. Adding the mkdocs-git-revision-date-localized-plugin and mkdocs-minify-plugin to the documentation dependencies.
  4. Adding a navigation footer.
  5. Adding a grid component to facilitate exploration and navigation.
  6. Various content improvements.
  7. Various design and aesthetic enhancements.
  8. Add custom 404 page.
  9. Add comment system with giscus.
  10. Add shortcodes badge accross project.
  11. Add mkdocstrings inventory

@codacy-production

codacy-production Bot commented Oct 11, 2026 •

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

🟢 Metrics 114 complexity · 0 duplication

Metric Results
Complexity 114
Duplication 0

View in Codacy

NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.

@github-actions

github-actions Bot commented Oct 11, 2026 •

Copy link
Copy Markdown
PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-10-17 12:41 UTC

@kaburagisec
kaburagisec merged commit f566fc1 into dev Oct 17, 2026
11 checks passed
@kaburagisec
kaburagisec deleted the docs/overhaul branch October 17, 2026 12:42
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