🤖 Fix #52: docs: add FAQ / troubleshooting page#62
Merged
JacobPEvans-personal merged 3 commits intoMay 25, 2026
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a new FAQ and Troubleshooting guide (docs/faq.md) and updates the README.md with relevant links. The guide covers common issues related to schema validation, performance, publishing, and CI. A review comment correctly identifies that the osv-scanner configuration example in the FAQ uses an incorrect format and provides a suggestion to align it with the project's existing osv-scanner.toml structure.
JacobPEvans-personal
force-pushed
the
fix/issue-52-docs-add-faq-troubleshooting
branch
from
59c4f09 to
1a43ff8
Compare
Signed-off-by: JacobPEvans <20714140+JacobPEvans@users.noreply.github.com>
Signed-off-by: JacobPEvans <20714140+JacobPEvans@users.noreply.github.com>
JacobPEvans-personal
force-pushed
the
fix/issue-52-docs-add-faq-troubleshooting
branch
from
1a43ff8 to
80a415d
Compare
Per gemini-code-assist on PR #62: the FAQ example used a fictional `[[osv.ignore]]` / `expires` shape. The repo's actual osv-scanner.toml uses `[[IgnoredVulns]]` headers and `ignoreUntil` with an unquoted TOML date literal. Align the example to what readers will actually find in the file the FAQ tells them to edit. Assisted-by: Claude <noreply@anthropic.com>
JacobPEvans-personal
deleted the
fix/issue-52-docs-add-faq-troubleshooting
branch
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
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 #52
Problem
Common operational issues hit users with no documented answer: envelope validation failures, slow inference, HF upload 401s, viewer cache delays, and OSV suppress patterns. The README references
docs/but has no FAQ entry.Approach
Create a new
docs/faq.mdwith four sections (Envelope/Schema, Inference/Performance, Publishing, CI) covering the specific questions called out in the issue. Update README.md to includefaq.mdin the docs directory tree listing and add a cross-reference line alongside the existingdocs/schema.mdreference.Files changed
docs/faq.md— new FAQ file with 4 Q&A sectionsREADME.md— addfaq.mdto docs tree listing; add cross-reference after schema.md linkCI status
none — no check-runs defined at branch creation time; CI triggers on pull_request event
Self-review
This PR was drafted by Issue Solver and is opened as a DRAFT for human review before merge. The Hard Rules in the prompt enforce: signed commits via Contents API, no dependency changes, no infra/workflow edits, secret-pattern pre-flight scan.
Note:
README.mdalready containsexport HF_TOKEN="hf_..."(line 193) — a pre-existing documentation placeholder that triggers the token regex. This line was not introduced by this PR and is not a real credential.Generated by Issue Solver — prompt source: https://github.com/JacobPEvans/claude-code-routines/blob/main/routines/issue-solver.prompt.md