docs(get-started): add quickstart, improve title/meta, add concept page CTAs#351
Open
zawadzkidiana wants to merge 3 commits into
Open
docs(get-started): add quickstart, improve title/meta, add concept page CTAs#351zawadzkidiana wants to merge 3 commits into
zawadzkidiana wants to merge 3 commits into
Conversation
…ge CTAs Signed-off-by: Diana Zawadzki <dzawa@live.de>
…idebar Signed-off-by: Diana Zawadzki <dzawa@live.de>
…low#347) Signed-off-by: Diana Zawadzki <dzawa@live.de>
CI failed: The CI build failed due to 14 broken links in the documentation, caused by incorrectly formatted root-relative paths and an expired or restricted Slack invite link.OverviewThe documentation link-checking suite (lychee) failed during validation. The errors are primarily caused by unresolved root-relative paths in the newly added 'get-started' documentation and one unreachable external URL. FailuresBroken Documentation Links (confidence: high)
Summary
Code Review ✅ ApprovedRewrites the get-started index page with an added 5-minute quickstart and a structured navigation table for concepts. No issues found. Rules ✅ All requirements metRepository Rules
Tip Comment OptionsAuto-apply is off → Gitar will not commit updates to this branch. Comment with these commands to change:
Was this helpful? React with 👍 / 👎 | Gitar |
2 tasks
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 changed?
Rewrote the `docs/get-started` index page: updated the page title and meta description for tutorial search intent, added a 5-minute SQLite quickstart above the fold, and replaced the prose "What's Next" section with a structured table linking to key Concepts and SDK guides.
Why?
The existing title ("Get Started") did not match how developers search for this content. The page had a low click-through rate pointing to a title/meta problem rather than a ranking problem. The quickstart removes the main friction point: visitors previously had to read through prose to find a first command to run. The structured What's Next table makes the onward journey explicit rather than relying on sidebar navigation.
How did you verify it?
`npm run build` — clean build.
`npm run start` — verified `/docs/get-started` renders the quickstart section and What's Next table correctly.
`npm run preview:github-pages -- --serve` — confirmed the page renders correctly in dark and light mode.
Potential risks
The What's Next table links to `/docs/concepts/workflow-engine` and `/docs/concepts/open-source-workflow-engine`. These pages ship in PR #350 — merge that first or the links will 404 until it lands.
Related changes
Depends on PR #350 (`docs(concepts): add workflow engine and open source workflow engine pages`).