Repository navigation
docs: add from-scratch tutorials for Go CLI project and docs site - #25
Merged
Merged
Conversation
- docs/{zh,en}/quick-start/golang-project-from-scratch.md: hands-on Go CLI
tutorial covering go mod init and go.mod line by line, the Cobra/Viper/PTerm
dependency stack, cmd/internal/pkg layering, a first Cobra subcommand, and a
Taskfile walkthrough with a minimal template; includes installable SKILL
golang-project-from-scratch
- docs/{zh,en}/quick-start/docs-site-from-scratch.md: hands-on docmd site
tutorial covering npm init and package.json fields, installing docmd,
docmd.config.js, navigation.json + bilingual i18n, and publishing to GitHub
Pages via the repo's docs.yml workflow; includes installable SKILL
docs-site-from-scratch
- register both pages in docs/{zh,en}/navigation.json
- record the work as section 9 in AGENTS.md
Co-Authored-By: Claude Code <noreply@anthropic.com>
Closed
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.
Closes #24
Adds two hands-on, beginner-friendly tutorials (zh + en mirrors) covering both halves of the issue:
Part 1 — Go CLI project from scratch
docs/{zh,en}/quick-start/golang-project-from-scratch.mdgo mod initgeneratesgo.mod, explained line by line (module / go / require / go.sum)cmd//internal//pkg//scripts/)cmd/magic/flush_dns.gogolang-project-from-scratchPart 2 — Docs site from scratch
docs/{zh,en}/quick-start/docs-site-from-scratch.mdnpm initwalkthrough with everypackage.jsonfield explained (+ Go↔Node mapping table)docmd.config.jsexplainednavigation.json, bilingual i18n rules.github/workflows/docs.yml(full workflow + Pages settings steps)docs-site-from-scratchAlso registers both pages in
docs/{zh,en}/navigation.jsonand records the work as section 9 inAGENTS.md.Verified with
npx docmd build: 60 pages generated, all 4 new pages render in both locales with correct sidebar entries.🤖 Generated with Claude Code