Skip to content

docs: make the local setup instructions work when followed - #804

Merged
jennifer-takagi merged 1 commit into
mainfrom
ktlo/fix-config-docs
Oct 1, 2026
Merged

jennifer-takagi merged 1 commit into
mainfrom
ktlo/fix-config-docs

Conversation

@jennifer-takagi

@jennifer-takagi jennifer-takagi commented Oct 1, 2026 •

Copy link
Copy Markdown
Collaborator

Description of change

Three small fixes so the Compiling & Running Locally section works when you follow it.

config.example ended with `};`, which is not valid JSON. The README's one
setup instruction is to base config.json on that file, so following it
exactly produced "SyntaxError: Unexpected token ';'".

The README's own usage snippet passed daysUntilStale: '730' as a string.
package-adoption validates the type and rejects it with "daysUntilStale
must be a number", so the snippet and config.example disagreed.

Also adds the cp command and states the daysUntilStale default of 365.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@jennifer-takagi
jennifer-takagi marked this pull request as ready for review October 1, 2026 11:57
@jennifer-takagi
jennifer-takagi requested a review from a team as a code owner October 1, 2026 11:57
@jennifer-takagi
jennifer-takagi merged commit af4a10c into main Oct 1, 2026
1 check passed
@jennifer-takagi
jennifer-takagi deleted the ktlo/fix-config-docs branch October 1, 2026 11:59
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