Skip to content

QVAC-18581 Docs - CLI issue - fix reference and create troubleshooting page#1935

Merged
BrunoCampana merged 10 commits into
mainfrom
docs/cli-doctor-fix
May 8, 2026
Merged

QVAC-18581 Docs - CLI issue - fix reference and create troubleshooting page#1935
BrunoCampana merged 10 commits into
mainfrom
docs/cli-doctor-fix

Conversation

@BrunoCampana

@BrunoCampana BrunoCampana commented May 6, 2026

Copy link
Copy Markdown
Contributor

Problem

QVAC CLI needs to be installed globally to work, and this is not in the docs.

Solution

  • On the CLI page: fix the CLI installation command.
  • Create a new “Troubleshooting” page to house all kinds of errors reported by users, like this one, as well as the solution.
  • Add this first and only section to the new page.

Minor fixes

  • Sitemap.ts: allow it to run in the staging env
  • Completion examples: update docs in light of examples in /packages/sdk/examples/ being moved.

New feature

Now it's possible to omit subsections in ToC.
Before: all markdown sections of the page appear in the ToC.
Now: you can define in the frontmatter what should be the cutoff.

New page preview

https://qvac-docs-staging-fazwv-commit-3d84b24.kinsta.page/troubleshooting/

@BrunoCampana BrunoCampana self-assigned this May 6, 2026
@BrunoCampana BrunoCampana requested review from a team as code owners May 6, 2026 23:09
@BrunoCampana BrunoCampana added documentation Improvements or additions to documentation tier1 labels May 6, 2026
@kinsta

kinsta Bot commented May 6, 2026

Copy link
Copy Markdown

Preview deployments for qvac-docs-staging ⚡️

Status Branch preview Commit preview
✅ Ready Visit preview Visit preview

Commit: b470d493295caa1d68d75e8bc7e3f9a67dddb768

Deployment ID: 673815ac-1e98-40b2-bd2d-b7bcaf818109

Static site name: qvac-docs-staging-fazwv

@github-actions

github-actions Bot commented May 6, 2026

Copy link
Copy Markdown
Contributor

Tier-based Approval Status

**PR Tier:** TIER1

**Current Status:** ✅ APPROVED

**Requirements:**
- 1 Team Member approval ✅ (1/1)
- 1 Team Lead OR Management approval ✅ (1/1)



---
*This comment is automatically updated when reviews change.*

simon-iribarren
simon-iribarren previously approved these changes May 7, 2026
yuranich
yuranich previously approved these changes May 8, 2026
@yuranich

yuranich commented May 8, 2026

Copy link
Copy Markdown
Contributor

/review

@BrunoCampana

Copy link
Copy Markdown
Contributor Author

/review

@BrunoCampana BrunoCampana requested a review from lauripiisang May 8, 2026 14:09
@BrunoCampana

Copy link
Copy Markdown
Contributor Author

/review

@BrunoCampana BrunoCampana merged commit c6d3e69 into main May 8, 2026
9 checks passed
@BrunoCampana BrunoCampana deleted the docs/cli-doctor-fix branch May 8, 2026 15:21
Proletter pushed a commit that referenced this pull request May 24, 2026
…g page (#1935)

* doc: examples changed path in sdk/examples

* doc: CLI - doctor - fix issue + create new page troubleshooting

* doc: CLI - doctor - fix issue + create new page troubleshooting

* doc: fix sitemap generation in staging env

* doc: frontend - make it possible to have ToCs using less subsections headings

* doc: add tip - requested by reviewer

* doc: add tip - requested by reviewer

---------

Co-authored-by: Yury Samarin <yuri.a.samarin@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation tier1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants