Repository navigation
Add docs.qcloud.systems knowledge base (MkDocs Material) - #21
Closed
qcloud-systems wants to merge 1 commit into
Closed
qcloud-systems wants to merge 1 commit into
qcloud-systems wants to merge 1 commit into
Conversation
New self-contained site in docs-site/, separate from info.qcloud.systems: - Three areas on one learning path: Engineering Notes (infrastructure, security, AWS, Hugo, GitHub, automation), Self-Hosting Guides (Docker, Linux, deployments, Cloudflare, monitoring) and Product Guides (installation, configuration, administration, troubleshooting) - Branded homepage: QCS palette, Inter, Q mark, learning-path strip - Section pages scaffolded with planned outlines, ready to fill from notes - First page: the Hugo static-site note, copied from notes/ (the original stays on info.qcloud.systems) - Contributing guide, review checklist and four page templates - Build hook that fails on credential-like strings (same patterns as notes.go) - Search, tags, light/dark themes, copy buttons, edit links CI: docs-site.yml runs `mkdocs build --strict` on changes to docs-site/. deploy.yml now ignores docs-site/ so docs edits don't redeploy the info site. Publishing is via Cloudflare Pages; setup steps are in docs-site/README.md. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01VhohB69QJSdMNT4DTUHpuC
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.
What this adds
A new, self-contained documentation site in
docs-site/, intended for docs.qcloud.systems. info.qcloud.systems is unchanged.Structure. There are three areas on one learning path (Engineering Note → Tutorial → Self-Hosting Guide → Product Documentation):
What's in it
notes/. The original stays on the info site.notes.goCI.
docs-site.ymlrunsmkdocs build --stricton changes underdocs-site/.deploy.ymlnow ignoresdocs-site/**, so docs edits don't redeploy info.qcloud.systems.To go live
Connect this repo in Cloudflare Pages with root directory
docs-site, then add the custom domaindocs.qcloud.systems. The exact settings are indocs-site/README.md.Preview locally
Generated by Claude Code