-
Notifications
You must be signed in to change notification settings - Fork 0
docs: consolidate and update documentation for M1.1–M1.3 and CE3 #10
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
flyingrobots
wants to merge
12
commits into
main
Choose a base branch
from
docs-consolidation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
5f65e77
docs: consolidate and update documentation for M1.1–M1.3 and CE3
1d7337b
fix: update doc freshness banners to reference v1.1.4
86fe33d
fix: harden check-doc-drift.sh regex and wire up dead root_gs_links c…
8a2c198
chore: update CHANGELOG with review round-1 fixes
eac9895
chore: add DOC1–DOC3 doc tooling backlog items to ROADMAP
5df52fe
fix: address review round-2 feedback from CodeRabbit
507bc58
chore: bump version to 1.1.5, update CHANGELOG and doc freshness banners
362c225
chore: add DOC4–DOC6 doc tooling backlog items to ROADMAP
7c09bbf
fix(security): prevent git identity leakage in CI workflow
flyingrobots f29d6f5
fix(ci): isolate git configuration using GIT_CONFIG_GLOBAL
flyingrobots 0d98b93
docs: address PR review feedback
flyingrobots 1f26254
fix(ci): robust git isolation and early installation
flyingrobots File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,73 +1,3 @@ | ||
| # Getting Started with Git CMS | ||
| # Getting Started | ||
|
|
||
| This quick guide is the lightweight entry point. For the full Docker-focused walkthrough in the docs folder, see [`docs/GETTING_STARTED.md`](docs/GETTING_STARTED.md). | ||
|
|
||
| --- | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - Git | ||
| - Node.js 22+ | ||
| - Docker Desktop (recommended for safe testing) | ||
|
|
||
| --- | ||
|
|
||
| ## Installation | ||
|
|
||
| ### Option A: Local CLI Install | ||
|
|
||
| ```bash | ||
| git clone https://github.com/flyingrobots/git-cms.git | ||
| cd git-cms | ||
| npm install | ||
| npm link | ||
| ``` | ||
|
|
||
| ### Option B: Docker (Recommended) | ||
|
|
||
| ```bash | ||
| git clone https://github.com/flyingrobots/git-cms.git | ||
| cd git-cms | ||
| npm run setup | ||
| npm run dev | ||
| ``` | ||
|
|
||
| Open the UI at [http://localhost:4638/](http://localhost:4638/). | ||
|
|
||
| --- | ||
|
|
||
| ## First Article | ||
|
|
||
| 1. Click `+ New Article`. | ||
| 2. Set a slug like `my-first-post`. | ||
| 3. Add title + body content. | ||
| 4. Click `Save Draft`. | ||
| 5. Click `Publish` when ready. | ||
|
|
||
| --- | ||
|
|
||
| ## CLI Basics | ||
|
|
||
| ```bash | ||
| # Draft reads content from stdin | ||
| echo "# Hello" | git cms draft hello-world "Hello World" | ||
|
|
||
| # List drafts | ||
| git cms list | ||
|
|
||
| # Publish | ||
| git cms publish hello-world | ||
|
|
||
| # Show article | ||
| git cms show hello-world | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## Safety Notes | ||
|
|
||
| - Prefer Docker workflows while learning. | ||
| - Use a dedicated test repository for local CLI experimentation. | ||
| - Avoid running low-level Git plumbing in repositories you care about. | ||
|
|
||
| See [`TESTING_GUIDE.md`](TESTING_GUIDE.md) for safety and cleanup procedures. | ||
| This guide has moved to [`docs/GETTING_STARTED.md`](docs/GETTING_STARTED.md). |
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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.