Move the doc generation (with NPM) out of the root project#87
Open
Move the doc generation (with NPM) out of the root project#87
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
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
2 participants
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.
Remove the root node_modules dependency
Docs generation is moved to docs-gen/ as a self-contained bun package (lifecycle scripts disabled by default via bunfig.toml). The root package.json and .prettierrc are deleted (Solidity formatting now goes through forge fmt, configured via .zed/settings.json and .vscode/settings.json).
just docsis the new entry point: cd docs-gen && bun install && bash prepare-docs.sh && bun run prepare-docs.js.Spawning a new nodejs process is not needed: The nav generation subprocess (gen-nav.js) is inlined into prepare-docs.js as a plain function, removing the child_process dependency and the CodeQL shell injection surface entirely.
npm-artifacts/prepare-abi.shis fixed: the dead pnpm install && pnpm run build block (which tried to build Solidity via a non-existent package.json in src/) is replaced with forge build. The artifacts-publish.yml workflow gains submodules: recursive and drops the broken root pnpm install step.