Uh oh!
There was an error while loading. Please reload this page.
feat: Automate documentation generation and cross-repo sync - #245
Conversation
Reorganized GenLayer Node API documentation to use a modular file structure with separate MDX files for each RPC method. This makes the docs easier to maintain and allows for better organization. Key changes: - Moved all RPC method docs into subdirectories (gen/ and debug/) - Updated main genlayer-node.mdx to use MDX imports instead of inline content - Added _meta.json files for navigation structure - Each method now has its own dedicated file for better maintainability - Added missing gen_getContractState method documentation The new structure follows the pattern: - genlayer-node/gen/ for main GenLayer methods - genlayer-node/debug/ for debug methods This approach keeps the main file clean and makes it simple to add new methods by creating a file and updating the imports.
Reorganized validator changelog to use a modular file structure with individual version files stored outside the pages directory. This prevents version pages from appearing in navigation while keeping all content on a single changelog page. Key changes: - Moved version files to content/validators/changelog/ directory - Updated changelog.mdx to import from the new content location - Changed heading levels: ## for versions, ### for subsections - Removed individual version pages from navigation menu The new structure enables proper table of contents navigation while maintaining a clean menu structure. Users see only "Changelog" in the menu but can navigate versions using the page's table of contents.
Added automated changelog generation that reads individual version files from content/validators/changelog/ and builds the main changelog page dynamically during the build process. Key changes: - Created generate-changelog.js script to combine version files - Integrated script into dev and build commands - Script automatically sorts versions in descending order - Handles both regular versions and testnet versions - Eliminates need for manual imports in changelog.mdx Now adding new changelog entries only requires creating a version file in the content directory. The build process handles everything else, making changelog maintenance much simpler and less error-prone.
Updated the changelog generation script to use MDX-compatible comment
syntax. MDX doesn't support HTML comments, so switched from <\!-- -->
to {/* */} format.
This fixes the build error that occurred when using HTML-style comments
in MDX files. The timestamp comment now uses the correct syntax and
the build process completes successfully.Created a script that dynamically generates the GenLayer Node API documentation from individual method files, similar to the changelog automation. The script automatically syncs _meta.json files with existing .mdx files, eliminating manual maintenance of imports and navigation entries.
Added npm/pnpm setup instructions for dev and production modes. Included guides for adding changelog entries and API methods.
Created a script that automatically updates the validator setup guide with the correct version list from the changelog directory. The script reads all version files, sorts them properly, and updates both the version list display and the export command to use the latest version. This eliminates manual maintenance when new versions are released.
Created a workflow that automatically syncs documentation from genlayer-node repository. The workflow clones the node repo, copies changelog and API docs (supporting both .md and .mdx files), runs documentation generation scripts, and creates a PR with all changes. Includes example trigger workflow and comprehensive documentation.
✅ Deploy Preview for genlayer-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughThis update removes a local JSON configuration file for allowed Bash commands, adds new GitHub Actions workflows and documentation for automating synchronization of documentation from the genlayer-node repository, introduces multiple changelog entries, expands npm scripts to include documentation generation, adds new API reference files and metadata, restructures changelog formatting, prunes older testnet versions from the setup guide, and adds new Node.js scripts for generating changelogs, API docs, and updating setup guide versions. Changes
Sequence Diagram(s)sequenceDiagram
participant NodeRepo as genlayer-node repo
participant DocsRepo as genlayer-docs repo
participant GitHubActions as GitHub Actions
participant Script as Node.js Scripts
NodeRepo->>GitHubActions: Push or manual trigger (example-trigger-from-node)
GitHubActions->>DocsRepo: repository_dispatch event (sync-docs)
DocsRepo->>GitHubActions: sync-docs-from-node workflow starts
GitHubActions->>DocsRepo: Checkout repo, setup Node.js
GitHubActions->>NodeRepo: Clone source branch
GitHubActions->>Script: Run generate-changelog.js
GitHubActions->>Script: Run update-setup-guide-versions.js
GitHubActions->>Script: Run generate-api-docs.js
GitHubActions->>DocsRepo: Commit & push changes if detected
GitHubActions->>DocsRepo: Create pull request with sync summary
Possibly related PRs
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File ( |
There was a problem hiding this comment.
Pull Request Overview
This PR automates documentation generation and synchronizes docs from the GenLayer Node repo, reducing manual maintenance.
- Adds Node.js scripts to generate changelogs, update setup guide versions, and build API docs
- Updates documentation pages (MDX) and README to integrate these scripts
- Implements a GitHub Actions workflow for cross-repository documentation sync
Reviewed Changes
Copilot reviewed 31 out of 32 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| scripts/update-setup-guide-versions.js | New script to inject latest version list into setup guide MDX |
| scripts/generate-changelog.js | New script to combine individual changelog MDX files |
| scripts/generate-api-docs.js | New script to aggregate API MDX method files into a single page |
| pages/validators/setup-guide.mdx | Removed stale version entries, now updated by script |
| pages/validators/changelog.mdx | Converted headings and added generation timestamp comment |
| pages/api-references/**/*.mdx and _meta.json | Added new API method docs and meta files for navigation |
| pages/api-references/genlayer-node.mdx | Cleaned up trailing code fence in combined API doc |
| package.json | Extended dev and build scripts to run new doc-generation tools |
| README.md | Expanded local setup and maintenance instructions |
| .github/workflows/sync-docs-from-node.yml | Added workflow to clone genlayer-node and sync documentation |
Comments suppressed due to low confidence (5)
pages/api-references/genlayer-node/gen/gen_call.mdx:12
- The parameter name
Datauses uppercase but the example JSON usesdata. Update the doc to use the exact field name (data) for consistency.
- `Data` (string, required): The encoded function call data
pages/api-references/genlayer-node/gen/gen_call.mdx:13
- The parameter name
Typeuses uppercase but the example JSON usestype. Update the doc to usetypeto match the JSON field.
- `Type` (string, required): The type of call (`"read"`, `"write"`, or `"deploy"`)
pages/api-references/genlayer-node/gen/gen_call.mdx:15
- The examples demonstrate a
gasfield, but it isn't listed in the parameters. Add- -gas(string, optional): The gas limit for the call (hex-encoded)to the parameter list.
- `value` (string, optional): The value to send with the call (hex-encoded)
pages/api-references/genlayer-node.mdx:369
- The closing triple backticks for the previous code block were removed, which will break the MDX parsing. Re-add ``` on its own line to properly close the code fence.
}
scripts/generate-changelog.js:9
- [nitpick] Consider adding unit tests for this script (and the other doc-generation scripts) to verify sorting logic and file I/O behavior, ensuring future changes don’t regress output.
function generateChangelog() {
There was a problem hiding this comment.
Actionable comments posted: 8
🧹 Nitpick comments (14)
content/validators/changelog/v0.3.1.mdx (1)
1-5: Polish grammar & keep style consistent with other entriesMinor wording tweak for clarity and to match the past-tense bullets used elsewhere.
-### Misc--- Add logs details+### Misc++- Added detailed loggingcontent/validators/changelog/v0.2.0-testnet004.mdx (1)
1-5: Align bullet tense with the rest of the changelogPrevious versions use past tense (“Added …”, “Fixed …”). Staying consistent improves readability.
-### Bug fixes--- Updated genvm to v0.0.18+### Bug fixes++- Updated genvm to v0.0.18content/validators/changelog/v0.2.0-testnet003.mdx (1)
1-5: Consistent heading placement & tenseThis is marked under “New features” yet only bumps genvm; if it’s a bug-fix release consider moving it, but at minimum keep bullet tense consistent:
-### New features--- Updated genvm to v0.0.17+### New features++- Updated genvm to v0.0.17content/validators/changelog/v0.3.3.mdx (1)
1-5: Nit: tiny wording tweak for consistencySlight rephrase keeps subject-verb order uniform with other bullets.
-- Added [Comput3](/validators/setup-guide#genvm-configuration) as a supported LLM provider for validators+- Added support for [Comput3](/validators/setup-guide#genvm-configuration) as an LLM provider for validatorsnext.config.js (1)
188-188: Restore newline at EOFPOSIX tools expect a trailing newline; restoring it avoids diff churn later.
module.exports = nextConfig; +content/validators/changelog/v0.2.0-testnet002.mdx (1)
5-6: Polish wording for clarity“A different address is used to run E2E tests” reads more naturally and keeps tense consistent with the other bullet lists across the changelog files.
-- Use different address to run e2e tests+- Use a different address to run E2E testscontent/validators/changelog/v0.2.0-testnet005.mdx (1)
5-10: Minor consistency tweaks
- Capitalise “E2E” and keep verbs in present tense for parallelism.
- Consider prefixing each bug-fix entry with a verb (“Process”, “Fix”) to follow the style adopted by previous versions.
- - Discover Consensus main genesis from deployment (contracts)+ - Discover Consensus main genesis from deployment contracts- - All accepted sync transactions are now processed atomically per block- - Fixed deadlock on cancelled context+ - Process all accepted sync transactions atomically per block+ - Fix deadlock on cancelled contextpages/api-references/genlayer-node.mdx (1)
365-369: Use a mermaid fenced block for long graph outputPlacing the result string inside a ```mermaid fenced block vastly improves readability and enables in-page rendering of the graph.
- "result": "graph TD\nnode0@{label: \"br seq=1\"}\n...+ "result": ```mermaid+graph TD+node0@{label: "br seq=1"}+node1@{label: "ext seq=1 0x00000000000000000000000000000000000000000000000000000000000000000000000"}+node1 --> data2@{label: "seq=1+[21 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0 0]"}+node0 -->|0| node1+node3@{label: "ext seq=1 0x72d46c3ada9f897c74d349bbfe0e450c798167c9f580f8daf85def57e96c3ea00000000"}+node3 --> data4@{label: "seq=1+[105 110 105 116 105 97 108 32 115 116 111 114 97 103 101 32 118 97 108 117 101 0 0 0 0 0 0 0 0 0 0 0]"}+node0 -->|3| node3+```pages/api-references/genlayer-node/debug/_meta.json (1)
1-4: Correct ordering but consider future growthIf additional debug methods are expected soon, adopting an explicit
"order"array (as used elsewhere in the docs) can avoid having to reshuffle keys manually.No change required for this PR – just a heads-up for maintainability.
content/validators/changelog/v0.2.0-testnet001.mdx (1)
9-15: Consistency nit – unify bullet-point punctuationLine 9 lacks a trailing period while 10 & 11 have one. Pick one style and apply it across all bullets in the file (and other changelog entries) to avoid visual noise.
pages/api-references/genlayer-node/debug/gen_dbg_ping.mdx (1)
13-30: Consider adding explicit output schema for clarityAlthough obvious here, following the same “Parameters | Returns” table format used by other RPC docs keeps things uniform and machine-scrapable.
Optional improvement:
| Field | Type | Description ||-------|------|-------------|| — | string | Always `"pong"`|scripts/generate-changelog.js (1)
13-16: Consider more robust error handling.The script exits silently when the changelog directory doesn't exist. Consider throwing an error or providing more explicit feedback for build processes.
if (!fs.existsSync(changelogDir)) { console.error(`Changelog directory ${changelogDir} does not exist`); - return;+ process.exit(1); }scripts/update-setup-guide-versions.js (1)
59-59: Consider making regex patterns more flexible.The current regex patterns are quite specific and may break if the setup guide format changes slightly. Consider adding more flexible whitespace handling.
- const versionListPattern = /(You should see a list like this\s*\n\s*```sh\n)([\s\S]*?)(\n\s*```\s*\n\s*Typically you will want)/;+ const versionListPattern = /(You should see a list like this\s*\n\s*```sh\n)([\s\S]*?)(\n\s*```\s*\n\s*Typically you will want)/;- const exportPattern = /export version=v[\d.]+(?:-testnet\d+)?/;+ const exportPattern = /export\s+version=v[\d.]+(?:-testnet\d+)?/;Also applies to: 71-71
.github/workflows/sync-docs-from-node.yml (1)
19-301: Fix YAML formatting issues.The workflow has multiple trailing spaces and is missing a newline at the end of the file, which violates YAML formatting standards.
Apply these formatting fixes:
- Remove trailing spaces from lines 19, 31, 88, 91, 95, 101, 109, 124, 128, 132, 138, 146, 151, 166, 170, 174, 180, 188, 193, 208, 211, 214, 223
- Add a newline at the end of the file (line 301)
else echo "ℹ️ No documentation changes detected. No PR created." >> $GITHUB_STEP_SUMMARY - fi+ fi+
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (4)
pages/api-references/genlayer-node/gen/_meta.jsonis excluded by!**/gen/**pages/api-references/genlayer-node/gen/gen_call.mdxis excluded by!**/gen/**pages/api-references/genlayer-node/gen/gen_getContractSchema.mdxis excluded by!**/gen/**pages/api-references/genlayer-node/gen/gen_getTransactionReceipt.mdxis excluded by!**/gen/**
📒 Files selected for processing (28)
.claude/settings.local.json(1 hunks).github/workflows/README.md(1 hunks).github/workflows/example-trigger-from-node.yml.example(1 hunks).github/workflows/sync-docs-from-node.yml(1 hunks)README.md(1 hunks)content/validators/changelog/v0.2.0-testnet001.mdx(1 hunks)content/validators/changelog/v0.2.0-testnet002.mdx(1 hunks)content/validators/changelog/v0.2.0-testnet003.mdx(1 hunks)content/validators/changelog/v0.2.0-testnet004.mdx(1 hunks)content/validators/changelog/v0.2.0-testnet005.mdx(1 hunks)content/validators/changelog/v0.2.0-testnet007.mdx(1 hunks)content/validators/changelog/v0.3.0.mdx(1 hunks)content/validators/changelog/v0.3.1.mdx(1 hunks)content/validators/changelog/v0.3.2.mdx(1 hunks)content/validators/changelog/v0.3.3.mdx(1 hunks)content/validators/changelog/v0.3.4.mdx(1 hunks)next.config.js(1 hunks)package.json(1 hunks)pages/api-references/genlayer-node.mdx(2 hunks)pages/api-references/genlayer-node/_meta.json(1 hunks)pages/api-references/genlayer-node/debug/_meta.json(1 hunks)pages/api-references/genlayer-node/debug/gen_dbg_ping.mdx(1 hunks)pages/api-references/genlayer-node/debug/gen_dbg_trie.mdx(1 hunks)pages/validators/changelog.mdx(3 hunks)pages/validators/setup-guide.mdx(0 hunks)scripts/generate-api-docs.js(1 hunks)scripts/generate-changelog.js(1 hunks)scripts/update-setup-guide-versions.js(1 hunks)
💤 Files with no reviewable changes (1)
- pages/validators/setup-guide.mdx
🧰 Additional context used
📓 Path-based instructions (5)
`next.config.js`: Next.js configuration and redirect rules are managed in next.c...
next.config.js: Next.js configuration and redirect rules are managed in next.config.js
For URL structure changes, add redirects to next.config.js and test both previousRedirects and actualRedirects arrays
Redirects are managed in next.config.js for URL structure changes
📄 Source: CodeRabbit Inference Engine (CLAUDE.md)
List of files the instruction was applied to:
next.config.js
`pages/**/_meta.json`: Navigation is controlled by _meta.json files in each dire...
pages/**/_meta.json: Navigation is controlled by _meta.json files in each directory
When adding new documentation pages, update the corresponding _meta.json to include the new page
To modify navigation, edit _meta.json files to change page ordering or titles
📄 Source: CodeRabbit Inference Engine (CLAUDE.md)
List of files the instruction was applied to:
pages/api-references/genlayer-node/_meta.jsonpages/api-references/genlayer-node/debug/_meta.json
`pages/**/*.mdx`: All content is in MDX format supporting React components When ...
pages/**/*.mdx: All content is in MDX format supporting React components
When adding new documentation pages, create a .mdx file in the appropriate pages/ subdirectory
All content should support React components within MDX files
📄 Source: CodeRabbit Inference Engine (CLAUDE.md)
List of files the instruction was applied to:
pages/api-references/genlayer-node.mdxpages/api-references/genlayer-node/debug/gen_dbg_ping.mdxpages/api-references/genlayer-node/debug/gen_dbg_trie.mdxpages/validators/changelog.mdx
`pages/validators/changelog.mdx`: When updating validator documentation for new ...
pages/validators/changelog.mdx: When updating validator documentation for new releases, add new version entries at the top of pages/validators/changelog.mdx in reverse chronological order and use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc
📄 Source: CodeRabbit Inference Engine (CLAUDE.md)
List of files the instruction was applied to:
pages/validators/changelog.mdx
`scripts/**/*.{js,ts}`: Build-time generation scripts are located in the scripts directory
scripts/**/*.{js,ts}: Build-time generation scripts are located in the scripts directory
📄 Source: CodeRabbit Inference Engine (CLAUDE.md)
List of files the instruction was applied to:
scripts/generate-changelog.jsscripts/generate-api-docs.jsscripts/update-setup-guide-versions.js
🧠 Learnings (23)
📓 Common learnings
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/generate-full-docs.js : Full documentation concatenation is performed by scripts/generate-full-docs.js
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, enhance command documentation in pages/validators/setup-guide.mdx when new features are added to existing commands
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/**/*.{js,ts} : Build-time generation scripts are located in the scripts directory
content/validators/changelog/v0.3.3.mdx (7)
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/changelog.mdx : When updating validator documentation for new releases, add new version entries at the top of pages/validators/changelog.mdx in reverse chronological order and use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, enhance command documentation in pages/validators/setup-guide.mdx when new features are added to existing commands
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update configuration examples with new contract addresses in pages/validators/setup-guide.mdx when applicable
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update genesis block configuration in the consensus section of pages/validators/setup-guide.mdx when network upgrades occur
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the setup-guide.mdx file
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update version references in download examples and version lists in pages/validators/setup-guide.mdx
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in relevant configuration examples
content/validators/changelog/v0.2.0-testnet003.mdx (5)
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/changelog.mdx : When updating validator documentation for new releases, add new version entries at the top of pages/validators/changelog.mdx in reverse chronological order and use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update genesis block configuration in the consensus section of pages/validators/setup-guide.mdx when network upgrades occur
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update configuration examples with new contract addresses in pages/validators/setup-guide.mdx when applicable
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, enhance command documentation in pages/validators/setup-guide.mdx when new features are added to existing commands
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in relevant configuration examples
content/validators/changelog/v0.3.1.mdx (2)
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/changelog.mdx : When updating validator documentation for new releases, add new version entries at the top of pages/validators/changelog.mdx in reverse chronological order and use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, enhance command documentation in pages/validators/setup-guide.mdx when new features are added to existing commands
content/validators/changelog/v0.3.4.mdx (8)
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update genesis block configuration in the consensus section of pages/validators/setup-guide.mdx when network upgrades occur
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup and should be updated in configuration examples when necessary
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/changelog.mdx : When updating validator documentation for new releases, add new version entries at the top of pages/validators/changelog.mdx in reverse chronological order and use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update configuration examples with new contract addresses in pages/validators/setup-guide.mdx when applicable
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the setup-guide.mdx file
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in relevant configuration examples
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, enhance command documentation in pages/validators/setup-guide.mdx when new features are added to existing commands
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update version references in download examples and version lists in pages/validators/setup-guide.mdx
content/validators/changelog/v0.3.2.mdx (6)
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update genesis block configuration in the consensus section of pages/validators/setup-guide.mdx when network upgrades occur
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in relevant configuration examples
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update configuration examples with new contract addresses in pages/validators/setup-guide.mdx when applicable
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, enhance command documentation in pages/validators/setup-guide.mdx when new features are added to existing commands
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/changelog.mdx : When updating validator documentation for new releases, add new version entries at the top of pages/validators/changelog.mdx in reverse chronological order and use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the setup-guide.mdx file
next.config.js (4)
Learnt from: epsjunior
PR: genlayerlabs/genlayer-docs#244
File: next-env.d.ts:3-6
Timestamp: 2025-07-09T18:27:44.033Z
Learning: Next.js automatically updates next-env.d.ts file during dependency updates, including adding new type references like "next/navigation-types/compat/navigation" when upgrading versions. These changes are not manual edits and should not be flagged as problematic.
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to next.config.js : Next.js configuration and redirect rules are managed in next.config.js
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to next.config.js : Redirects are managed in next.config.js for URL structure changes
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to next.config.js : For URL structure changes, add redirects to next.config.js and test both previousRedirects and actualRedirects arrays
pages/api-references/genlayer-node/_meta.json (3)
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/**/_meta.json : Navigation is controlled by _meta.json files in each directory
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/**/_meta.json : When adding new documentation pages, update the corresponding _meta.json to include the new page
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/**/_meta.json : To modify navigation, edit _meta.json files to change page ordering or titles
content/validators/changelog/v0.2.0-testnet005.mdx (5)
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update genesis block configuration in the consensus section of pages/validators/setup-guide.mdx when network upgrades occur
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in relevant configuration examples
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update configuration examples with new contract addresses in pages/validators/setup-guide.mdx when applicable
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/changelog.mdx : When updating validator documentation for new releases, add new version entries at the top of pages/validators/changelog.mdx in reverse chronological order and use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup and should be updated in configuration examples when necessary
content/validators/changelog/v0.2.0-testnet002.mdx (5)
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in relevant configuration examples
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update configuration examples with new contract addresses in pages/validators/setup-guide.mdx when applicable
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update genesis block configuration in the consensus section of pages/validators/setup-guide.mdx when network upgrades occur
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/changelog.mdx : When updating validator documentation for new releases, add new version entries at the top of pages/validators/changelog.mdx in reverse chronological order and use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, enhance command documentation in pages/validators/setup-guide.mdx when new features are added to existing commands
pages/api-references/genlayer-node/debug/_meta.json (3)
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/**/_meta.json : When adding new documentation pages, update the corresponding _meta.json to include the new page
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/**/_meta.json : Navigation is controlled by _meta.json files in each directory
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/**/_meta.json : To modify navigation, edit _meta.json files to change page ordering or titles
content/validators/changelog/v0.2.0-testnet001.mdx (3)
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update genesis block configuration in the consensus section of pages/validators/setup-guide.mdx when network upgrades occur
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/changelog.mdx : When updating validator documentation for new releases, add new version entries at the top of pages/validators/changelog.mdx in reverse chronological order and use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update configuration examples with new contract addresses in pages/validators/setup-guide.mdx when applicable
content/validators/changelog/v0.3.0.mdx (5)
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/changelog.mdx : When updating validator documentation for new releases, add new version entries at the top of pages/validators/changelog.mdx in reverse chronological order and use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update genesis block configuration in the consensus section of pages/validators/setup-guide.mdx when network upgrades occur
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update configuration examples with new contract addresses in pages/validators/setup-guide.mdx when applicable
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, enhance command documentation in pages/validators/setup-guide.mdx when new features are added to existing commands
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in relevant configuration examples
content/validators/changelog/v0.2.0-testnet004.mdx (6)
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/changelog.mdx : When updating validator documentation for new releases, add new version entries at the top of pages/validators/changelog.mdx in reverse chronological order and use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update genesis block configuration in the consensus section of pages/validators/setup-guide.mdx when network upgrades occur
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update configuration examples with new contract addresses in pages/validators/setup-guide.mdx when applicable
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in relevant configuration examples
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, enhance command documentation in pages/validators/setup-guide.mdx when new features are added to existing commands
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup and should be updated in configuration examples when necessary
pages/validators/changelog.mdx (8)
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/changelog.mdx : When updating validator documentation for new releases, add new version entries at the top of pages/validators/changelog.mdx in reverse chronological order and use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update version references in download examples and version lists in pages/validators/setup-guide.mdx
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, enhance command documentation in pages/validators/setup-guide.mdx when new features are added to existing commands
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update genesis block configuration in the consensus section of pages/validators/setup-guide.mdx when network upgrades occur
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update configuration examples with new contract addresses in pages/validators/setup-guide.mdx when applicable
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup and should be updated in configuration examples when necessary
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in relevant configuration examples
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the setup-guide.mdx file
scripts/generate-changelog.js (6)
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/generate-full-docs.js : Full documentation concatenation is performed by scripts/generate-full-docs.js
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/changelog.mdx : When updating validator documentation for new releases, add new version entries at the top of pages/validators/changelog.mdx in reverse chronological order and use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/**/*.{js,ts} : Build-time generation scripts are located in the scripts directory
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/generate-sitemap-xml.js : Sitemap generation is performed by scripts/generate-sitemap-xml.js
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update genesis block configuration in the consensus section of pages/validators/setup-guide.mdx when network upgrades occur
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, enhance command documentation in pages/validators/setup-guide.mdx when new features are added to existing commands
.claude/settings.local.json (3)
Learnt from: dohernandez
PR: genlayerlabs/genlayer-docs#239
File: .claude/settings.local.json:3-18
Timestamp: 2025-06-27T11:37:17.726Z
Learning: The `.claude/settings.local.json` file is specifically managed by Claude AI and contains intentionally broad wildcard patterns (like `Bash(git push:*)` and `Bash(gh pr create:*)`) to provide Claude AI with the flexibility needed to perform various Git operations during automated workflows. Security restrictions that would normally apply to user-facing permission files don't apply in the same way here.
Learnt from: dohernandez
PR: genlayerlabs/genlayer-docs#239
File: .claude/commands/pr.md:16-17
Timestamp: 2025-06-27T11:38:10.048Z
Learning: Files in the `.claude/` directory containing command specifications (like `.claude/commands/pr.md`) are prompt Claude code designed specifically for Claude AI's internal operations and automated workflows. Normal file handling restrictions and sanitization requirements that apply to general user-facing code may not apply in the same way to these Claude-specific files.
Learnt from: dohernandez
PR: genlayerlabs/genlayer-docs#239
File: .claude/commands/commit.md:25-26
Timestamp: 2025-06-27T11:40:09.798Z
Learning: Files in the `.claude/commands/` directory contain Claude AI command specifications and prompt code that define automated workflows for Claude AI. These command specifications may include conditional instructions and apparent contradictions that are actually intentional design patterns for Claude's command system (e.g., forbidding write operations by default but allowing them after user confirmation).
README.md (10)
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, enhance command documentation in pages/validators/setup-guide.mdx when new features are added to existing commands
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/changelog.mdx : When updating validator documentation for new releases, add new version entries at the top of pages/validators/changelog.mdx in reverse chronological order and use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/generate-full-docs.js : Full documentation concatenation is performed by scripts/generate-full-docs.js
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/**/*.mdx : When adding new documentation pages, create a .mdx file in the appropriate pages/ subdirectory
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/**/*.mdx : All content is in MDX format supporting React components
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update version references in download examples and version lists in pages/validators/setup-guide.mdx
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the setup-guide.mdx file
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update genesis block configuration in the consensus section of pages/validators/setup-guide.mdx when network upgrades occur
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup and should be updated in configuration examples when necessary
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update configuration examples with new contract addresses in pages/validators/setup-guide.mdx when applicable
scripts/generate-api-docs.js (6)
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/generate-full-docs.js : Full documentation concatenation is performed by scripts/generate-full-docs.js
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/**/*.{js,ts} : Build-time generation scripts are located in the scripts directory
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/generate-sitemap-xml.js : Sitemap generation is performed by scripts/generate-sitemap-xml.js
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/**/_meta.json : When adding new documentation pages, update the corresponding _meta.json to include the new page
Learnt from: epsjunior
PR: genlayerlabs/genlayer-docs#244
File: next-env.d.ts:3-6
Timestamp: 2025-07-09T18:27:44.033Z
Learning: Next.js automatically updates next-env.d.ts file during dependency updates, including adding new type references like "next/navigation-types/compat/navigation" when upgrading versions. These changes are not manual edits and should not be flagged as problematic.
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/**/*.mdx : When adding new documentation pages, create a .mdx file in the appropriate pages/ subdirectory
scripts/update-setup-guide-versions.js (10)
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, enhance command documentation in pages/validators/setup-guide.mdx when new features are added to existing commands
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update version references in download examples and version lists in pages/validators/setup-guide.mdx
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update genesis block configuration in the consensus section of pages/validators/setup-guide.mdx when network upgrades occur
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/changelog.mdx : When updating validator documentation for new releases, add new version entries at the top of pages/validators/changelog.mdx in reverse chronological order and use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update configuration examples with new contract addresses in pages/validators/setup-guide.mdx when applicable
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/generate-full-docs.js : Full documentation concatenation is performed by scripts/generate-full-docs.js
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup and should be updated in configuration examples when necessary
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in relevant configuration examples
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : GenVM diagnostics integration affects the doctor command behavior and should be documented in the setup-guide.mdx file
Learnt from: epsjunior
PR: genlayerlabs/genlayer-docs#244
File: next-env.d.ts:3-6
Timestamp: 2025-07-09T18:27:44.033Z
Learning: Next.js automatically updates next-env.d.ts file during dependency updates, including adding new type references like "next/navigation-types/compat/navigation" when upgrading versions. These changes are not manual edits and should not be flagged as problematic.
content/validators/changelog/v0.2.0-testnet007.mdx (6)
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update genesis block configuration in the consensus section of pages/validators/setup-guide.mdx when network upgrades occur
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/changelog.mdx : When updating validator documentation for new releases, add new version entries at the top of pages/validators/changelog.mdx in reverse chronological order and use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update configuration examples with new contract addresses in pages/validators/setup-guide.mdx when applicable
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup and should be updated in configuration examples when necessary
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : Consensus contract addresses change with network upgrades and must be updated in relevant configuration examples
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, enhance command documentation in pages/validators/setup-guide.mdx when new features are added to existing commands
package.json (3)
Learnt from: epsjunior
PR: genlayerlabs/genlayer-docs#244
File: next-env.d.ts:3-6
Timestamp: 2025-07-09T18:27:44.033Z
Learning: Next.js automatically updates next-env.d.ts file during dependency updates, including adding new type references like "next/navigation-types/compat/navigation" when upgrading versions. These changes are not manual edits and should not be flagged as problematic.
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/**/*.{js,ts} : Build-time generation scripts are located in the scripts directory
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/generate-full-docs.js : Full documentation concatenation is performed by scripts/generate-full-docs.js
.github/workflows/sync-docs-from-node.yml (1)
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/generate-full-docs.js : Full documentation concatenation is performed by scripts/generate-full-docs.js
🪛 LanguageTool
content/validators/changelog/v0.3.1.mdx
[uncategorized] ~5-~5: Dieses Wort müsste großgeschrieben werden. Überlegen Sie, es zu ändern.
Context: ## v0.3.1 ### Misc - Add logs details
(AI_DE_GGEC_REPLACEMENT_ORTHOGRAPHY_LOWERCASE)
🪛 actionlint (1.7.7)
.github/workflows/sync-docs-from-node.yml
253-253: the runner of "peter-evans/create-pull-request@v5" action is too old to run on GitHub Actions. update the action's version to fix this issue
(action)
🪛 YAMLlint (1.37.1)
.github/workflows/sync-docs-from-node.yml
[error] 19-19: trailing spaces
(trailing-spaces)
[error] 31-31: trailing spaces
(trailing-spaces)
[error] 88-88: trailing spaces
(trailing-spaces)
[error] 91-91: trailing spaces
(trailing-spaces)
[error] 95-95: trailing spaces
(trailing-spaces)
[error] 101-101: trailing spaces
(trailing-spaces)
[error] 109-109: trailing spaces
(trailing-spaces)
[error] 124-124: trailing spaces
(trailing-spaces)
[error] 128-128: trailing spaces
(trailing-spaces)
[error] 132-132: trailing spaces
(trailing-spaces)
[error] 138-138: trailing spaces
(trailing-spaces)
[error] 146-146: trailing spaces
(trailing-spaces)
[error] 151-151: trailing spaces
(trailing-spaces)
[error] 166-166: trailing spaces
(trailing-spaces)
[error] 170-170: trailing spaces
(trailing-spaces)
[error] 174-174: trailing spaces
(trailing-spaces)
[error] 180-180: trailing spaces
(trailing-spaces)
[error] 188-188: trailing spaces
(trailing-spaces)
[error] 193-193: trailing spaces
(trailing-spaces)
[error] 208-208: trailing spaces
(trailing-spaces)
[error] 211-211: trailing spaces
(trailing-spaces)
[error] 214-214: trailing spaces
(trailing-spaces)
[error] 223-223: trailing spaces
(trailing-spaces)
[error] 301-301: no new line character at the end of file
(new-line-at-end-of-file)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - genlayer-docs
- GitHub Check: Header rules - genlayer-docs
- GitHub Check: Pages changed - genlayer-docs
🔇 Additional comments (23)
pages/api-references/genlayer-node/_meta.json (1)
1-10: LGTM – structure is clearThe separators correctly group GenLayer and Debug methods; no further action required.
pages/api-references/genlayer-node/debug/gen_dbg_ping.mdx (1)
1-10: Upgrade heading level to be the page titleMDX pages normally start with a single top-level
#heading which is rendered as the page title. Starting at###skips two levels and hurts accessibility / ToC generation.-### gen_dbg_ping+# gen_dbg_pingPlease verify other newly-generated API docs follow the same convention.
pages/validators/changelog.mdx (1)
4-126: Heading level deviates from agreed formatInternal guideline: “add new version entries at the top of pages/validators/changelog.mdx using
# v0.x.x,## New features, …”.The generated file uses
## v0.x.x, one level lower. Either:
- Update the generator to emit
# v…, or- Amend the guideline if the team decided to down-level all headings.
Keeping guideline-code parity avoids future merge noise.
content/validators/changelog/v0.2.0-testnet007.mdx (1)
1-21: LGTM! Changelog entry follows established format.The changelog entry correctly follows the expected format with proper version header and categorized sections. The content is well-structured and informative, documenting the new features, bug fixes, and miscellaneous updates for v0.2.0-testnet007.
content/validators/changelog/v0.3.0.mdx (1)
1-19: LGTM! Changelog entry follows established format.The changelog entry correctly follows the expected format with proper version header and categorized sections. The content is well-structured and informative, documenting the new features and bug fixes for v0.3.0.
.claude/settings.local.json (1)
17-31: LGTM! Added permissions support new automation workflows.The additional bash command permissions are appropriate for the new automation scripts and workflows being introduced. The permissions for Node.js, npm, file system operations, and git commands align well with the changelog generation, API documentation generation, and other automation tasks.
pages/api-references/genlayer-node/debug/gen_dbg_trie.mdx (1)
1-38: LGTM! Well-structured API reference documentation.The API reference documentation for
gen_dbg_triefollows a consistent and comprehensive format. The documentation includes:
- Clear method description and purpose
- Detailed parameter specifications with types and requirements
- Complete JSON-RPC request and response examples
- Proper MDX formatting
The documentation is informative and follows established patterns for API reference documentation.
scripts/generate-changelog.js (1)
58-61: LGTM! Well-structured content generation.The changelog content generation with timestamp comment and proper MDX formatting is well-implemented. The approach of joining sections with double newlines maintains proper spacing between changelog entries.
.github/workflows/README.md (1)
1-84: Comprehensive workflow documentation - looks good!The documentation provides clear instructions for the cross-repository sync workflow. The structure is logical, examples are helpful, and all necessary configuration details are covered.
.github/workflows/example-trigger-from-node.yml.example (1)
1-43: Well-structured example workflow.The example workflow is clear and includes all necessary components for triggering the documentation sync. The comments provide good guidance for implementation.
package.json (2)
6-7: Good integration of documentation generation scripts.The sequential execution of generation scripts before Next.js commands ensures documentation is always up-to-date during development and build processes.
10-12: Convenient individual script access.The addition of individual npm scripts provides flexibility for running specific generators when needed.
README.md (3)
9-40: Excellent setup documentation for both package managers.The parallel instructions for pnpm and npm provide clear guidance for developers with different preferences. The structure is consistent and easy to follow.
41-72: Clear changelog maintenance workflow.The documentation explains the automated changelog generation process well, including file structure, naming conventions, and the build integration.
74-128: Comprehensive API documentation workflow.The API documentation section provides a complete template and explains the automation process clearly. The examples are helpful for contributors.
scripts/generate-api-docs.js (4)
1-5: LGTM! Clean imports and shebang setup.The script correctly sets up the Node.js environment and imports the necessary modules for file system operations.
9-58: Well-structured function with good error handling.The
updateMetaJsonfunction properly handles the synchronization of _meta.json files with existing .mdx files while preserving order. The error handling for JSON parsing is appropriate.
109-206: Excellent template structure with comprehensive API documentation.The generated API documentation template is well-structured and includes:
- Clear sections for different method types
- Comprehensive usage examples with cURL commands
- Proper documentation of compatibility layers (Ethereum, zkSync)
- Realistic examples with proper JSON-RPC format
The template demonstrates good documentation practices and provides developers with actionable examples.
214-218: Proper CLI and module interface implementation.The script correctly implements both CLI usage (when run directly) and programmatic usage (when imported as a module). The conditional check and module export follow Node.js best practices.
.github/workflows/sync-docs-from-node.yml (4)
3-12: LGTM! Proper trigger configuration for automation.The workflow correctly supports both automated (repository_dispatch) and manual (workflow_dispatch) triggers with appropriate default values.
55-61: Verify token permissions for cross-repository access.The clone operation uses
NODE_REPO_TOKENwhich is good for security, but ensure this token has the necessary permissions to access the genlayer-node repository.
83-117: Robust file synchronization logic with good error handling.The changelog sync implementation properly handles:
- Directory existence checks
- File comparison to avoid unnecessary updates
- Progress tracking and reporting
- Support for both .mdx and .md files
The logic is sound and includes appropriate error handling.
14-25: No changes needed for checkout token usageThe initial checkout uses
secrets.GITHUB_TOKENto clone the current repository, which is sufficient. The cross-repository clone ofgenlayerlabs/genlayer-nodealready leveragessecrets.NODE_REPO_TOKEN || secrets.GITHUB_TOKENvia theGITHUB_TOKENenvironment variable in that step—no additional token refactor is required.Likely an incorrect or invalid review comment.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
AgustinRamiroDiaz
left a comment
There was a problem hiding this comment.
remember to put the secret to be able to cross fetch from the other repo
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
MuncleUscles
left a comment
There was a problem hiding this comment.
high level looks good to me
- Fix version sorting logic comments to match implementation - Add file existence check for setup guide before reading - Make API doc paths configurable via environment variables - Add logging for missing directories instead of silent skipping - Fix GitHub Actions shell interpolation for PR body - Update Create Pull Request action from v5 to v7.0.8 - Rename npm scripts with 'node-' prefix for clarity - Remove timestamp from generated changelog to avoid merge conflicts
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
.github/workflows/sync-docs-from-node.yml (1)
1-312: Large number of trailing spaces flagged by yamllint
yamllinterrors will fail the workflow-linting stage in most CI setups.
Run your formatter (prettier/yamlfmt) to strip trailing blanks and add the
missing final newline.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
.claude/settings.local.json(1 hunks).github/workflows/sync-docs-from-node.yml(1 hunks)package.json(1 hunks)pages/validators/changelog.mdx(3 hunks)scripts/generate-api-docs.js(1 hunks)scripts/generate-changelog.js(1 hunks)scripts/update-setup-guide-versions.js(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (6)
- scripts/generate-changelog.js
- .claude/settings.local.json
- pages/validators/changelog.mdx
- scripts/update-setup-guide-versions.js
- scripts/generate-api-docs.js
- package.json
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/generate-full-docs.js : Full documentation concatenation is performed by scripts/generate-full-docs.js
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, enhance command documentation in pages/validators/setup-guide.mdx when new features are added to existing commands
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/**/*.{js,ts} : Build-time generation scripts are located in the scripts directory
.github/workflows/sync-docs-from-node.yml (1)
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/generate-full-docs.js : Full documentation concatenation is performed by scripts/generate-full-docs.js
🪛 YAMLlint (1.37.1)
.github/workflows/sync-docs-from-node.yml
[error] 19-19: trailing spaces
(trailing-spaces)
[error] 31-31: trailing spaces
(trailing-spaces)
[error] 88-88: trailing spaces
(trailing-spaces)
[error] 91-91: trailing spaces
(trailing-spaces)
[error] 95-95: trailing spaces
(trailing-spaces)
[error] 101-101: trailing spaces
(trailing-spaces)
[error] 109-109: trailing spaces
(trailing-spaces)
[error] 124-124: trailing spaces
(trailing-spaces)
[error] 128-128: trailing spaces
(trailing-spaces)
[error] 132-132: trailing spaces
(trailing-spaces)
[error] 138-138: trailing spaces
(trailing-spaces)
[error] 146-146: trailing spaces
(trailing-spaces)
[error] 151-151: trailing spaces
(trailing-spaces)
[error] 166-166: trailing spaces
(trailing-spaces)
[error] 170-170: trailing spaces
(trailing-spaces)
[error] 174-174: trailing spaces
(trailing-spaces)
[error] 180-180: trailing spaces
(trailing-spaces)
[error] 188-188: trailing spaces
(trailing-spaces)
[error] 193-193: trailing spaces
(trailing-spaces)
[error] 208-208: trailing spaces
(trailing-spaces)
[error] 211-211: trailing spaces
(trailing-spaces)
[error] 214-214: trailing spaces
(trailing-spaces)
[error] 223-223: trailing spaces
(trailing-spaces)
[error] 312-312: no new line character at the end of file
(new-line-at-end-of-file)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
- GitHub Check: Redirect rules - genlayer-docs
- GitHub Check: Header rules - genlayer-docs
- GitHub Check: Pages changed - genlayer-docs
🔇 Additional comments (1)
.github/workflows/sync-docs-from-node.yml (1)
221-229: Arithmetic expansion may break if any output is emptyIf one of the
*_updatedoutputs is missing or non-numeric,$(( … ))aborts
with “value too great for base”. Wrap the values with a default:TOTAL_UPDATES=$((${SYNC_CHANGELOG:-0}+${SYNC_API_GEN:-0}+${SYNC_API_DEBUG:-0}))(or
:-0inline with each expression literal).
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Implement sparse checkout in the GitHub workflow to significantly reduce clone time and bandwidth usage. Instead of cloning the entire genlayer-node repository, we now only fetch the docs folder which contains all the documentation files we need to sync. The workflow now: - Initializes a sparse git repository - Configures it to only checkout the docs/* path - Fetches with --depth 1 for minimal history - Still properly fetches tags for version tracking
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
.github/workflows/sync-docs-from-node.yml (1)
246-250:git add .still stages the transientsync_report.mdartefactWe previously suggested excluding this generated file to keep history clean; the line is unchanged.
- git add .+ git add --all ":!sync_report.md"
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/sync-docs-from-node.yml(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/generate-full-docs.js : Full documentation concatenation is performed by scripts/generate-full-docs.js
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, enhance command documentation in pages/validators/setup-guide.mdx when new features are added to existing commands
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/**/*.{js,ts} : Build-time generation scripts are located in the scripts directory
.github/workflows/sync-docs-from-node.yml (1)
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/generate-full-docs.js : Full documentation concatenation is performed by scripts/generate-full-docs.js
🪛 YAMLlint (1.37.1)
.github/workflows/sync-docs-from-node.yml
[error] 19-19: trailing spaces
(trailing-spaces)
[error] 31-31: trailing spaces
(trailing-spaces)
[error] 61-61: trailing spaces
(trailing-spaces)
[error] 65-65: trailing spaces
(trailing-spaces)
[error] 100-100: trailing spaces
(trailing-spaces)
[error] 103-103: trailing spaces
(trailing-spaces)
[error] 107-107: trailing spaces
(trailing-spaces)
[error] 113-113: trailing spaces
(trailing-spaces)
[error] 121-121: trailing spaces
(trailing-spaces)
[error] 136-136: trailing spaces
(trailing-spaces)
[error] 140-140: trailing spaces
(trailing-spaces)
[error] 144-144: trailing spaces
(trailing-spaces)
[error] 150-150: trailing spaces
(trailing-spaces)
[error] 158-158: trailing spaces
(trailing-spaces)
[error] 163-163: trailing spaces
(trailing-spaces)
[error] 178-178: trailing spaces
(trailing-spaces)
[error] 182-182: trailing spaces
(trailing-spaces)
[error] 186-186: trailing spaces
(trailing-spaces)
[error] 192-192: trailing spaces
(trailing-spaces)
[error] 200-200: trailing spaces
(trailing-spaces)
[error] 205-205: trailing spaces
(trailing-spaces)
[error] 220-220: trailing spaces
(trailing-spaces)
[error] 223-223: trailing spaces
(trailing-spaces)
[error] 226-226: trailing spaces
(trailing-spaces)
[error] 235-235: trailing spaces
(trailing-spaces)
[error] 324-324: no new line character at the end of file
(new-line-at-end-of-file)
Uh oh!
There was an error while loading. Please reload this page.
Replace automatic tag fetching with explicit tag parameter in workflow_dispatch and repository_dispatch. Update branch naming to docs/node/{tag} format and move sync report to temp directory.There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
.github/workflows/sync-docs-from-node.yml (1)
232-232: Avoid staging temporary sync report fileThe
git add .command will stage all files, including the temporarysync_report.mdfile, which should not be committed to the repository.- git add .+ git add content/ pages/ --ignore-errorsOr use a more selective approach:
- git add .+ git add content/validators/changelog/ pages/api-references/genlayer-node/ --ignore-errors
🧹 Nitpick comments (1)
.github/workflows/sync-docs-from-node.yml (1)
24-307: Clean up formatting issuesThe workflow has multiple trailing spaces and is missing a newline at the end of the file.
Run the following command to fix formatting:
sed -i 's/[[:space:]]*$//' .github/workflows/sync-docs-from-node.yml echo"">> .github/workflows/sync-docs-from-node.ymlOr configure your editor to automatically remove trailing whitespace and ensure files end with a newline.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.github/workflows/example-trigger-from-node.yml.example(1 hunks).github/workflows/sync-docs-from-node.yml(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/generate-full-docs.js : Full documentation concatenation is performed by scripts/generate-full-docs.js
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, enhance command documentation in pages/validators/setup-guide.mdx when new features are added to existing commands
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/**/*.{js,ts} : Build-time generation scripts are located in the scripts directory
.github/workflows/sync-docs-from-node.yml (1)
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/generate-full-docs.js : Full documentation concatenation is performed by scripts/generate-full-docs.js
🪛 actionlint (1.7.7)
.github/workflows/sync-docs-from-node.yml
23-23: context "runner" is not allowed here. available contexts are "github", "inputs", "matrix", "needs", "secrets", "strategy", "vars". see https://docs.github.com/en/actions/learn-github-actions/contexts#context-availability for more details
(expression)
🪛 YAMLlint (1.37.1)
.github/workflows/sync-docs-from-node.yml
[error] 24-24: trailing spaces
(trailing-spaces)
[error] 36-36: trailing spaces
(trailing-spaces)
[error] 83-83: trailing spaces
(trailing-spaces)
[error] 86-86: trailing spaces
(trailing-spaces)
[error] 90-90: trailing spaces
(trailing-spaces)
[error] 96-96: trailing spaces
(trailing-spaces)
[error] 104-104: trailing spaces
(trailing-spaces)
[error] 119-119: trailing spaces
(trailing-spaces)
[error] 123-123: trailing spaces
(trailing-spaces)
[error] 127-127: trailing spaces
(trailing-spaces)
[error] 133-133: trailing spaces
(trailing-spaces)
[error] 141-141: trailing spaces
(trailing-spaces)
[error] 146-146: trailing spaces
(trailing-spaces)
[error] 161-161: trailing spaces
(trailing-spaces)
[error] 165-165: trailing spaces
(trailing-spaces)
[error] 169-169: trailing spaces
(trailing-spaces)
[error] 175-175: trailing spaces
(trailing-spaces)
[error] 183-183: trailing spaces
(trailing-spaces)
[error] 188-188: trailing spaces
(trailing-spaces)
[error] 203-203: trailing spaces
(trailing-spaces)
[error] 206-206: trailing spaces
(trailing-spaces)
[error] 209-209: trailing spaces
(trailing-spaces)
[error] 218-218: trailing spaces
(trailing-spaces)
[error] 307-307: no new line character at the end of file
(new-line-at-end-of-file)
🔇 Additional comments (4)
.github/workflows/example-trigger-from-node.yml.example (1)
1-58: LGTM: Well-structured example workflow for cross-repo automationThis example workflow provides a clear template for setting up automated documentation sync from the genlayer-node repository. The implementation correctly:
- Uses appropriate triggers (push to main with path filters + manual dispatch)
- Handles tag detection with fallback to commit SHA
- Configures repository dispatch with proper payload structure
- Includes helpful comments and summary output
Regarding the past comment about removing this file: This example serves an important purpose by documenting how to set up the triggering side of the cross-repo automation. Users need this template to complete the sync setup.
.github/workflows/sync-docs-from-node.yml (3)
62-71: Authentication properly configured for private repository accessThe workflow correctly uses
NODE_REPO_TOKEN || secrets.GITHUB_TOKENfor authentication and leveragesactions/checkout@v4with sparse checkout. This addresses the authentication concerns raised in past reviews.
259-259: GitHub Action version properly updatedGood job updating to
peter-evans/create-pull-request@v7.0.8- this addresses the compatibility issues flagged in past reviews.
78-196: Robust file synchronization logicThe three sync steps (changelog, API gen, API debug) are well-implemented with:
- Proper file extension handling (.md to .mdx conversion)
- Change detection using
cmp -s- Comprehensive logging to sync report
- Graceful handling of missing source directories
Uh oh!
There was an error while loading. Please reload this page.
Fixed GitHub Actions workflow error by moving SYNC_REPORT environment variable from job-level env to individual step runs where runner context is available.
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (5)
.github/workflows/sync-docs-from-node.yml (5)
70-75: Make branch creation idempotent
git checkout -bfails if the branch already exists (e.g. re-runs on the same tag).
Use the force-switch form to reuse/reset the branch safely.- git checkout -b $BRANCH_NAME+ git switch --force-create $BRANCH_NAME 2>/dev/null || git switch -C $BRANCH_NAME
90-102: Handle deleted files to keep docs in syncCurrent loops only copy new/updated files. If a file is removed from
genlayer-node, it lingers here forever.
Consider usingrsync --deleteor a prune step to mirror removals and avoid stale docs.Also applies to: 128-140, 171-183
30-37: Cache npm dependencies to cut CI timeInstalling from scratch on every run is slow.
Leverageactions/setup-nodecache support:- uses: actions/setup-node@v4with: node-version: '18'+ cache: 'npm'
231-241: Avoid committing unintended artefacts
git add .can still stage lock-files, local config or future temp artefacts.
Restrict the pathspec to the directories modified by the sync:- git add .+ git add content/validators/changelog pages/api-referencesAdd more paths if the generation scripts touch additional folders.
1-310: Clean trailing whitespace for YAML-lint complianceStatic analysis flags ~25 trailing-space errors and a missing final newline.
A quicksed -i 's/[ \t]*$//'on the file will silence the linter and keep diffs tidy.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/sync-docs-from-node.yml(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/generate-full-docs.js : Full documentation concatenation is performed by scripts/generate-full-docs.js
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, enhance command documentation in pages/validators/setup-guide.mdx when new features are added to existing commands
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/**/*.{js,ts} : Build-time generation scripts are located in the scripts directory
.github/workflows/sync-docs-from-node.yml (1)
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/generate-full-docs.js : Full documentation concatenation is performed by scripts/generate-full-docs.js
🪛 YAMLlint (1.37.1)
.github/workflows/sync-docs-from-node.yml
[error] 22-22: trailing spaces
(trailing-spaces)
[error] 34-34: trailing spaces
(trailing-spaces)
[error] 82-82: trailing spaces
(trailing-spaces)
[error] 85-85: trailing spaces
(trailing-spaces)
[error] 89-89: trailing spaces
(trailing-spaces)
[error] 95-95: trailing spaces
(trailing-spaces)
[error] 103-103: trailing spaces
(trailing-spaces)
[error] 119-119: trailing spaces
(trailing-spaces)
[error] 123-123: trailing spaces
(trailing-spaces)
[error] 127-127: trailing spaces
(trailing-spaces)
[error] 133-133: trailing spaces
(trailing-spaces)
[error] 141-141: trailing spaces
(trailing-spaces)
[error] 146-146: trailing spaces
(trailing-spaces)
[error] 162-162: trailing spaces
(trailing-spaces)
[error] 166-166: trailing spaces
(trailing-spaces)
[error] 170-170: trailing spaces
(trailing-spaces)
[error] 176-176: trailing spaces
(trailing-spaces)
[error] 184-184: trailing spaces
(trailing-spaces)
[error] 189-189: trailing spaces
(trailing-spaces)
[error] 205-205: trailing spaces
(trailing-spaces)
[error] 208-208: trailing spaces
(trailing-spaces)
[error] 211-211: trailing spaces
(trailing-spaces)
[error] 220-220: trailing spaces
(trailing-spaces)
[error] 310-310: no new line character at the end of file
(new-line-at-end-of-file)
🔇 Additional comments (1)
.github/workflows/sync-docs-from-node.yml (1)
46-58: Double-check GitHub expression fallback syntax
${{ github.event.client_payload.source_branch || 'main' }}relies on the||operator that evaluates to an empty string, notnull, when the key is missing.
In that case the fallback may not trigger. Validate with a dry-run or switch to the safer??coalescing operator now supported by Actions.echo"source_branch=${{ github.event.client_payload.source_branch ?? 'main' }}">>$GITHUB_OUTPUT
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Added `set -euo pipefail` to all multiline bash scripts in the sync workflow to ensure proper error handling and prevent partial syncs. Also cleaned up trailing spaces throughout the workflow file.
Enable cone mode for sparse checkout to improve clone performance when fetching only the docs folder from the genlayer-node repository.
Made several improvements to the sync workflow based on code review: - Use idempotent branch creation with `git switch --force-create` - Handle file deletions properly by clearing destinations before sync - Add npm dependency caching for faster CI runs - Restrict git add to only modified directories
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (2)
.github/workflows/sync-docs-from-node.yml (2)
270-274:total_updatesignores deletions
TOTAL_UPDATESonly sums the “copied” counts.
If a sync consists solely of deletions the PR body will misleadingly show 0 files updated even though files were removed.Consider adding the
DELETED_FILEScounts (or countinggit diff --name-only) to reflect the real delta.
85-120: Trailing spaces flagged by YAMLlintThe static analysis hints list ~20 lines with trailing whitespace.
While harmless at runtime, they fail common CI lint jobs (yamllint,actionlint) and pollute diffs.Run a formatter (e.g.
prettier --writeoryamlfmt) before merging.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/sync-docs-from-node.yml(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/generate-full-docs.js : Full documentation concatenation is performed by scripts/generate-full-docs.js
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, enhance command documentation in pages/validators/setup-guide.mdx when new features are added to existing commands
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/**/*.{js,ts} : Build-time generation scripts are located in the scripts directory
.github/workflows/sync-docs-from-node.yml (1)
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/generate-full-docs.js : Full documentation concatenation is performed by scripts/generate-full-docs.js
🪛 YAMLlint (1.37.1)
.github/workflows/sync-docs-from-node.yml
[error] 94-94: trailing spaces
(trailing-spaces)
[error] 97-97: trailing spaces
(trailing-spaces)
[error] 100-100: trailing spaces
(trailing-spaces)
[error] 112-112: trailing spaces
(trailing-spaces)
[error] 116-116: trailing spaces
(trailing-spaces)
[error] 120-120: trailing spaces
(trailing-spaces)
[error] 144-144: trailing spaces
(trailing-spaces)
[error] 147-147: trailing spaces
(trailing-spaces)
[error] 150-150: trailing spaces
(trailing-spaces)
[error] 162-162: trailing spaces
(trailing-spaces)
[error] 170-170: trailing spaces
(trailing-spaces)
[error] 174-174: trailing spaces
(trailing-spaces)
[error] 178-178: trailing spaces
(trailing-spaces)
[error] 202-202: trailing spaces
(trailing-spaces)
[error] 205-205: trailing spaces
(trailing-spaces)
[error] 208-208: trailing spaces
(trailing-spaces)
[error] 220-220: trailing spaces
(trailing-spaces)
[error] 228-228: trailing spaces
(trailing-spaces)
[error] 232-232: trailing spaces
(trailing-spaces)
[error] 236-236: trailing spaces
(trailing-spaces)
[error] 256-256: trailing spaces
(trailing-spaces)
[error] 259-259: trailing spaces
(trailing-spaces)
[error] 269-269: trailing spaces
(trailing-spaces)
[error] 363-363: no new line character at the end of file
(new-line-at-end-of-file)
🔇 Additional comments (1)
.github/workflows/sync-docs-from-node.yml (1)
45-61: Guard against empty/undefined payload fieldsWhen the dispatch payload omits a field (e.g.,
api_gen_path), the${{ github.event.client_payload.api_gen_path || ... }}expression is evaluated at workflow-parse time.
If the key is absent the entire expression isnull, causing an empty string to be echoed and later path handling to fail.A safer pattern is to resolve inside bash after the workflow starts:
SOURCE_BRANCH="${{ github.event.client_payload.source_branch }}" SOURCE_BRANCH=${SOURCE_BRANCH:-main}(or supply explicit default inputs on the trigger side).
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Fixed two issues in the sync-docs-from-node workflow: - Changed environment variable from lowercase `branch_name` to uppercase `BRANCH_NAME` following shell conventions - Fixed incorrect `sparse-checkout-cone-mode` parameter to `sparse-checkout-cone` for proper sparse checkout functionality
Added `.claude/settings.local.json` to gitignore to keep local Claude configuration out of version control.
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (1)
.github/workflows/sync-docs-from-node.yml (1)
461-468: Timestamp source is misleading.
${{ github.event.repository.updated_at }}reflects the repo’s last push, not the workflow run.
For an accurate run timestamp use${{ github.run_started_at }}.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/workflows/sync-docs-from-node.yml(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/generate-full-docs.js : Full documentation concatenation is performed by scripts/generate-full-docs.js
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, enhance command documentation in pages/validators/setup-guide.mdx when new features are added to existing commands
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/**/*.{js,ts} : Build-time generation scripts are located in the scripts directory
.github/workflows/sync-docs-from-node.yml (1)
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/generate-full-docs.js : Full documentation concatenation is performed by scripts/generate-full-docs.js
🪛 actionlint (1.7.7)
.github/workflows/sync-docs-from-node.yml
71-71: input "sparse-checkout-cone" is not defined in action "actions/checkout@v4". available inputs are "clean", "fetch-depth", "fetch-tags", "filter", "github-server-url", "lfs", "path", "persist-credentials", "ref", "repository", "set-safe-directory", "show-progress", "sparse-checkout", "sparse-checkout-cone-mode", "ssh-key", "ssh-known-hosts", "ssh-strict", "ssh-user", "submodules", "token"
(action)
🔇 Additional comments (1)
.github/workflows/sync-docs-from-node.yml (1)
58-60: Path mismatch between dispatch and manual runs – verify defaults.
repository_dispatchdefaultsapi_gen_pathtodocs/api/rpc/gen, whileworkflow_dispatchfalls back todocs/api/gen.
Unless both layouts exist, one of the triggers will copy from a non-existent directory and report “Source API gen directory not found”.Confirm which path is authoritative and align both defaults.
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
Fixed issues identified in PR review: - Exclude _meta.json files from change count metrics while still syncing them - Fix sparse-checkout parameter name to sparse-checkout-cone-mode - Use github.run_started_at for accurate workflow timestamp instead of repository.updated_at
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
.claude/settings.local.json(0 hunks).github/workflows/sync-docs-from-node.yml(1 hunks).gitignore(1 hunks)
💤 Files with no reviewable changes (1)
- .claude/settings.local.json
✅ Files skipped from review due to trivial changes (1)
- .gitignore
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/generate-full-docs.js : Full documentation concatenation is performed by scripts/generate-full-docs.js
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update genesis block configuration in the consensus section of pages/validators/setup-guide.mdx when network upgrades occur
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, enhance command documentation in pages/validators/setup-guide.mdx when new features are added to existing commands
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : Genesis block numbers are specified for faster node startup and should be updated in configuration examples when necessary
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/changelog.mdx : When updating validator documentation for new releases, add new version entries at the top of pages/validators/changelog.mdx in reverse chronological order and use consistent format: # v0.x.x, ## New features, ## Bug fixes, ## Misc
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to pages/validators/setup-guide.mdx : When updating validator documentation for new releases, update configuration examples with new contract addresses in pages/validators/setup-guide.mdx when applicable
.github/workflows/sync-docs-from-node.yml (2)
Learnt from: CR
PR: genlayerlabs/genlayer-docs#0
File: CLAUDE.md:0-0
Timestamp: 2025-06-30T14:01:39.620Z
Learning: Applies to scripts/generate-full-docs.js : Full documentation concatenation is performed by scripts/generate-full-docs.js
Learnt from: dohernandez
PR: genlayerlabs/genlayer-docs#245
File: .github/workflows/sync-docs-from-node.yml:69-72
Timestamp: 2025-07-14T09:14:00.194Z
Learning: The correct parameter name for enabling cone mode in sparse checkout for actions/checkout@v4 is `sparse-checkout-cone-mode` (not `sparse-checkout-cone`). This parameter should be set to `true` to enable cone mode for directory-based sparse checkout optimization.
🪛 actionlint (1.7.7)
.github/workflows/sync-docs-from-node.yml
448-448: property "run_started_at" is not defined in object type {action: string; action_path: string; action_ref: string; action_repository: string; action_status: string; actor: string; actor_id: string; api_url: string; artifact_cache_size_limit: number; base_ref: string; env: string; event: object; event_name: string; event_path: string; graphql_url: string; head_ref: string; job: string; output: string; path: string; ref: string; ref_name: string; ref_protected: bool; ref_type: string; repository: string; repository_id: string; repository_owner: string; repository_owner_id: string; repository_visibility: string; repositoryurl: string; retention_days: number; run_attempt: string; run_id: string; run_number: string; secret_source: string; server_url: string; sha: string; state: string; step_summary: string; token: string; triggering_actor: string; workflow: string; workflow_ref: string; workflow_sha: string; workspace: string}
(expression)
🔇 Additional comments (2)
.github/workflows/sync-docs-from-node.yml (2)
67-72: Cone-mode flag is now correct – good catch
actions/checkout@v4expectssparse-checkout-cone-mode, and you supply it.
This will keep the checkout fast while still limiting the tree todocs/.
385-395: Shell arithmetic becomes brittle with direct expression interpolationInside
$(( … ))any non-numeric token breaks the arithmetic.
If an output is the empty string (e.g., a missing step) the whole expression aborts underset -euo pipefail.Prefer
${VAR:-0}in the shell after interpolation:-TOTAL_ADDED=$(( ${{ steps.sync_changelog.outputs.changelog_added || 0 }} + \- ${{ steps.sync_api_gen.outputs.api_gen_added || 0 }} + \- ${{ steps.sync_api_debug.outputs.api_debug_added || 0 }} ))+TOTAL_ADDED=$(( ${{+ steps.sync_changelog.outputs.changelog_added+}} 0 + ${{+ steps.sync_api_gen.outputs.api_gen_added+}} 0 + ${{+ steps.sync_api_debug.outputs.api_debug_added+}} 0 ))(or compute the sums with
expr/awkoutside the arithmetic context).
This eliminates a class of “value required” runtime errors.Likely an incorrect or invalid review comment.
Uh oh!
There was an error while loading. Please reload this page.
Added a step to capture the current UTC timestamp since github.run_started_at is not a valid GitHub context variable. This ensures the PR body displays the actual workflow execution time instead of an empty string.
Description
This PR introduces comprehensive automation for the GenLayer documentation site, eliminating manual maintenance of changelog entries, API documentation, and cross-repository synchronization. The changes include automated scripts that generate documentation during the build process and a GitHub Action workflow that syncs documentation from the genlayer-node repository.
Motivation and Context
The documentation site previously required manual updates for changelog entries, API method documentation, and keeping content synchronized with the node repository. This led to maintenance overhead and potential inconsistencies. These changes automate the entire process, making documentation updates more reliable and reducing the chance of errors.
Changes Made
Testing
All documentation generation scripts have been tested locally and integrated into the build process. The GitHub Action workflow has been designed with error handling and detailed reporting.
Types of Changes
Checklist:
Summary by CodeRabbit
New Features
gen_dbg_pingandgen_dbg_trie.Improvements
Chores
.gitignore.