docs: add Your First Model guided walkthrough#93
Merged
Conversation
Bridges the gap the docs audit flagged (SWOT W2, high concept load): getting-started wires the agent, concepts explains vocabulary, but there was no page taking one concrete model end-to-end. This does that for an faq collection — define -> save -> publish -> read -> query -> review — with real tool responses, on-disk files, and git log captured from an actual @contentrain/mcp run against a scratch project (nothing invented). Covers the load-bearing distinctions: object-map storage vs array output, draft-on-save vs bulk-publish, auto-merge vs review workflow (both branch responses shown), and the generated #contentrain SDK query. Added to nav, sidebar (first guide), and the llms.txt / llms-full ordering. vitepress build clean.
✅ Deploy Preview for contentrain-ai ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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 the onboarding gap the docs audit flagged (SWOT W2 — high concept load): Getting Started wires up the agent and Core Concepts explains the vocabulary, but nothing took a single concrete model end-to-end. This adds that bridge page. (Follow-up to #90, now merged.)
What it is
A guided walkthrough of an
faqcollection — the kind that exercises the most machinery — taken all the way through:status→model_save→content_save→bulkpublish →content_list→validate+generate→ SDK query → and finally a review-mode save +diff+merge.Every output is real
I did not hand-write the tool responses. I ran the built
@contentrain/mcpserver over InMemoryTransport against a scratch project, plus the CLI forvalidate/generate/diff/merge, and pasted the actual output. Entry IDs (898df4b18fc4, …), branch names, commit hashes, the on-disken.jsonobject-map, the meta file, thegit log, and the SDK query result (node query-test.mjs→[ 'Do I need a cloud account?', 'What is Contentrain?' ]) are all captured, not invented. The page says so up front and notes those values differ per machine.This is deliberately the opposite of what the audit cleaned up in #90 — no fabricated examples that drift from behavior.
Load-bearing distinctions it makes concrete
content_listdrafton save; onlybulk update_statuspublishesauto-mergevsreviewworkflow — bothgit.actionresponses (auto-mergedandpending-review) shown side by side, then thediff+mergeloopWiring
Added to top nav, sidebar (first guide), the static
llms.txt, and theLLMS_PAGE_ORDERforllms-full.txt.vitepress buildclean.🤖 Generated with Claude Code