docs: add foundation documentation structure#218
Open
shiv-tyagi wants to merge 1 commit into
Open
Conversation
ef77915 to
78d825c
Compare
There was a problem hiding this comment.
Pull request overview
This PR restructures Spur’s documentation by replacing the old monolithic docs/quickstart.md with a Sphinx/ReST-style doc tree (getting started, deployment, developer guides) and updating top-level entry points to link into the new structure.
Changes:
- Replace
docs/quickstart.mdwith a newdocs/index.rst+ sectioned guides underdocs/deployment/anddocs/developer/. - Update
README.mdto be a short overview with install/run snippets and pointers into the new docs. - Add a short
crates/spur-tests/README.mdthat points contributors to the E2E instructions in the developer docs.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Replaces long-form README content with highlights, install, and doc signposts. |
| docs/quickstart.md | Removes the old markdown quickstart guide. |
| docs/index.rst | Adds a top-level docs landing page and toctree. |
| docs/getting-started.rst | Adds a concise single-node quickstart and Slurm-compat usage examples. |
| docs/deployment/index.rst | Adds deployment section toctree. |
| docs/deployment/bare-metal.rst | Adds bare-metal install/controller/HA/worker join guidance. |
| docs/deployment/kubernetes.rst | Adds Kubernetes deployment guide and SpurJob CRD example. |
| docs/developer/index.rst | Adds developer section toctree. |
| docs/developer/building.rst | Adds build + unit and E2E test instructions (bare-metal and Kubernetes). |
| docs/developer/contributing.rst | Adds contribution workflow, commit style, hooks, and PR process. |
| crates/spur-tests/README.md | Adds a pointer from the test crate to the developer E2E docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
a4d0578 to
58efe93
Compare
Replace the monolithic quickstart.md with a structured documentation set: - Trimmed README to elevator pitch + signposts - Quickstart (single-node, try-it-locally) - Deployment section (bare-metal with WireGuard mesh, Kubernetes with operator) - Developer section (building/testing guide with E2E instructions, contributing guide)
58efe93 to
c9014d3
Compare
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
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.
Summary
Replace the monolithic
docs/quickstart.mdwith a structured documentation set covering the essential paths for users and contributors.Structure
Changes
docs/quickstart.md