docs(CLAUDE.md): typedoc is regenerated by CI, don't commit it#128
Merged
Merged
Conversation
The first pass of the doc-process section (#126/#127) prescribed 'regenerate typedoc and commit the diff' for any change to the curated public surface. That guidance was wrong: the in-repo 'Check that web client documentation is up-to-date' CI step runs typedoc and then a git diff --exit-code over the regenerated tree, but the directory hasn't been tracked since the web/WASM split — so the diff is empty and the step is a warning-only smoke test, not a gate. typedoc output is build artifact, not source. Updates four spots in the doc-process section: - 'Typedoc — keep in sync with the public API surface' → 'Typedoc — regenerated by CI, don't commit' - The MidenClient surface table row for docs/typedoc/web-client/ now reads 'Don't commit. Regenerated by CI...' - The Conventions bullet 'Regenerate typedoc' became 'Don't commit typedoc' - Contributing checklist item 3 mirrors that Triggered by web-sdk#31 audit feedback: noticed the autogen tree shouldn't have been committed there either. Companion .gitignore addition lands separately on web-sdk#31.
WiktorStarczewski
added
the
no changelog
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.
Summary
Reverses a wrong prescription introduced in #126/#127. That earlier doc-process section told contributors to "regenerate typedoc and commit the diff" for any change reaching the curated public surface — but the in-repo verification step (
Check that web client documentation is up-to-dateintest.yml) has been a no-op since the web/WASM split: it runsgit diff --exit-codeoverdocs/typedoc/web-client/, which is untracked, so the diff is empty and the step is warning-only.typedoc output is build artifact, not source. The companion fix on web-sdk#31 (commit c743d0f) gitignores the directory; this PR aligns the doc-process rule with that reality.
Changes
docs/typedoc/web-client/now says don't commitCompanion PR
Same change against the other long-lived branch.
Test plan