Add documentation site and professional README#3
Merged
Merged
Conversation
- New MkDocs Material docs site under docs/ (index, install, commands, configuration, how-it-works, status-line, contributing) with an SVG banner. - mkdocs.yml + pinned docs/requirements.txt (CI/docs-only deps; runtime stays stdlib-only). - .github/workflows/docs.yml builds the site and deploys to GitHub Pages on push to main (and workflow_dispatch). - README rewritten as a landing page: banner, status badges, human-voiced intro, commands table, and links into the docs site. Tests unaffected (327 passed); version 0.4.0 consistent.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a proper documentation site and rewrites the README as an open-source landing page.
What's included
docs/— Home, Install, Commands, Configuration, How it works, Status line, Contributing — with an SVG hero banner.mkdocs.yml(theme, nav, dark/light palette, search) anddocs/requirements.txtwith pinned build deps. These are CI/docs-only; the plugin's Python runtime stays stdlib-only..github/workflows/docs.yml— builds the site withmkdocs build --strictand deploys to GitHub Pages via the official Pages actions, on push tomainandworkflow_dispatch.One manual step before Pages goes live
In Settings → Pages, set the source to "GitHub Actions." Once merged and the workflow runs, the site publishes to https://dropdevrahul.github.io/nexum/.
Notes
mainwith Pages enabled.