Skip to content

docs(get-started): add quickstart, improve title/meta, add concept page CTAs#351

Open
zawadzkidiana wants to merge 3 commits into
cadence-workflow:masterfrom
zawadzkidiana:diana/get-started-quickstart
Open

docs(get-started): add quickstart, improve title/meta, add concept page CTAs#351
zawadzkidiana wants to merge 3 commits into
cadence-workflow:masterfrom
zawadzkidiana:diana/get-started-quickstart

Conversation

@zawadzkidiana
Copy link
Copy Markdown
Contributor

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.

  • Ran production preview (`npm run preview:github-pages -- --serve`)
  • Checked dark mode and light mode on affected pages

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`).

…ge CTAs

Signed-off-by: Diana Zawadzki <dzawa@live.de>
…idebar

Signed-off-by: Diana Zawadzki <dzawa@live.de>
@gitar-bot
Copy link
Copy Markdown

gitar-bot Bot commented Jun 1, 2026

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.

Overview

The 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.

Failures

Broken Documentation Links (confidence: high)

  • Type: test
  • Affected jobs: 78930946631
  • Related to change: yes
  • Root cause: The documentation uses root-relative paths (e.g., /docs/concepts/...) which the link checker cannot resolve because it lacks a configured base directory. Additionally, a 403 Forbidden error was triggered by an external Slack invitation link.
  • Suggested fix: Convert all root-relative links in the changed files to relative paths (e.g., ../concepts/...). Verify the validity of the external Slack URL and replace it if the 403 error persists.

Summary

  • Change-related failures: 1 (Documentation link validation failed).
  • Infrastructure/flaky failures: 0
  • Recommended action: Update the link syntax in docs/01-get-started/index.md to use standard relative paths and validate or remove the broken external link.
Code Review ✅ Approved

Rewrites the get-started index page with an added 5-minute quickstart and a structured navigation table for concepts. No issues found.

Rules ✅ All requirements met

Repository Rules

Markdown Frontmatter Completeness: The updated docs/01-get-started/index.md contains a complete and correctly formatted frontmatter block.
PR Description Quality Standards: The PR description provides a clear 'What', 'Why', and 'How' with concrete verification steps including production preview verification, meeting all PR template guidance.

Tip

Comment Gitar fix CI or enable auto-apply: gitar auto-apply:on

Options

Auto-apply is off → Gitar will not commit updates to this branch.
Display: compact → Showing less information.

Comment with these commands to change:

Auto-apply Compact
gitar auto-apply:on         
gitar display:verbose         

Was this helpful? React with 👍 / 👎 | Gitar

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant