Skip to content

docs: add MkDocs documentation with Read the Docs theme#1

Merged
Basigli merged 2 commits intomainfrom
copilot/document-project-using-mkdocs
Mar 18, 2026
Merged

docs: add MkDocs documentation with Read the Docs theme#1
Basigli merged 2 commits intomainfrom
copilot/document-project-using-mkdocs

Conversation

Copy link
Copy Markdown

Copilot AI commented Mar 18, 2026

Adds a complete documentation site for Squid Storage using MkDocs with the built-in readthedocs theme.

Structure

  • mkdocs.yml — site config, nav tree, theme
  • docs/index.md — project overview, feature summary, quick links
  • docs/getting-started.md — prerequisites, build, running all three components, local cluster example
  • docs/architecture.md — component diagram, data-flow for file updates, consistency/replication model
  • docs/components/{server,datanode,client}.md — internals per component (state maps, lifecycle, dual-socket design, etc.)
  • docs/protocol.md — Squid Protocol wire format, full message reference, file transfer framing
  • docs/configuration.md — all CLI parameters with defaults across Server, DataNode, Client
  • docs/contributing.md — commit conventions, branching, versioning, changelog
  • docs/requirements.txtmkdocs>=1.6.0

CI

.github/workflows/docs.yml — deploys to GitHub Pages on push to main when docs/ or mkdocs.yml changes.

Preview locally

pip install mkdocs
mkdocs serve
# → http://127.0.0.1:8000

site/ added to .gitignore.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: Basigli <84378604+Basigli@users.noreply.github.com>
Copilot AI changed the title [WIP] Add documentation for the project docs: add MkDocs documentation with Read the Docs theme Mar 18, 2026
Copilot AI requested a review from Basigli March 18, 2026 15:34
@Basigli Basigli marked this pull request as ready for review March 18, 2026 15:35
@Basigli Basigli merged commit 5a386f2 into main Mar 18, 2026
3 checks passed
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.

2 participants