Skip to content

chore(repo): align node metadata and refresh operator-layer docs#3136

Merged
drewstone merged 1 commit into
developfrom
drew/config-readme-operator-layer-cleanup
Mar 3, 2026
Merged

chore(repo): align node metadata and refresh operator-layer docs#3136
drewstone merged 1 commit into
developfrom
drew/config-readme-operator-layer-cleanup

Conversation

@drewstone
Copy link
Copy Markdown
Contributor

Summary

  • align Node runtime metadata by updating .nvmrc to 18.18 and package.json engines to >=18.18.x
  • remove stale apps/tangle-cloud/pnpm-lock.yaml to keep Yarn as the single package-manager source of truth
  • refresh root README.md for current product positioning: Tangle Operator Layer for AI services and tnt-core-aligned local development
  • modernize app-level docs by updating apps/tangle-dapp/README.md and adding apps/tangle-cloud/README.md

Validation

  • yarn lint
  • yarn build
  • pre-push checks also executed successfully (format:check, test, build)

@drewstone drewstone requested a review from AtelyPham as a code owner March 3, 2026 20:17
@netlify
Copy link
Copy Markdown

netlify Bot commented Mar 3, 2026

Deploy Preview for tangle-dapp ready!

Name Link
🔨 Latest commit 41d116d
🔍 Latest deploy log https://app.netlify.com/projects/tangle-dapp/deploys/69a741f15491c200084f644d
😎 Deploy Preview https://deploy-preview-3136--tangle-dapp.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify
Copy link
Copy Markdown

netlify Bot commented Mar 3, 2026

Deploy Preview for tangle-leaderboard ready!

Name Link
🔨 Latest commit 41d116d
🔍 Latest deploy log https://app.netlify.com/projects/tangle-leaderboard/deploys/69a741f18fd9ad0007480a71
😎 Deploy Preview https://deploy-preview-3136--tangle-leaderboard.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@claude
Copy link
Copy Markdown

claude Bot commented Mar 3, 2026

Claude finished @drewstone's task —— View job


PR Review Complete ✅

Reviewing PR: chore(repo): align node metadata and refresh operator-layer docs

Todo List:

  • Read and analyze all changed files
  • Review Node.js version alignment (.nvmrc and package.json)
  • Review documentation updates (README.md files)
  • Check pnpm-lock.yaml removal appropriateness
  • Provide comprehensive feedback on code quality, security, and best practices
  • Submit final review

Review Feedback

Overall Assessment: LGTM

This is a well-executed repository maintenance PR that properly aligns Node.js version requirements and refreshes documentation to reflect the current product positioning. The changes are consistent, appropriate, and improve the repository's clarity.

Detailed Analysis

Node.js Version Alignment

  • .nvmrc: Updated from unspecified to 18.18 - Good
  • package.json: Updated engines to "node": ">=18.18.x" - Good
  • Consistency: Both files now properly align on Node.js 18.18.x minimum requirement
  • Best Practice: Using .nvmrc with package.json engines provides both developer tooling support and runtime enforcement

Package Manager Cleanup

  • apps/tangle-cloud/pnpm-lock.yaml deletion is appropriate
  • Verified no references to this file exist in the codebase
  • Maintains single package manager source of truth (Yarn) as stated in updated README.md:103
  • Prevents CI/tooling drift between package managers

Documentation Updates

Root README.md - Excellent modernization:

  • Clear positioning as "Tangle Operator Layer for AI services"
  • Updated tech stack section with specific versions (Node.js >= 18.18.x)
  • Added tnt-core integration guidance - critical for local development
  • Improved quick start instructions with corepack enablement
  • Added package manager policy section - good governance
  • Maintains all essential information while improving clarity

App-level READMEs - Good consistency:

  • apps/tangle-dapp/README.md: Clear, focused on end-user staking flows
  • apps/tangle-cloud/README.md: New addition, well-structured for operator/developer workflows
  • Both follow consistent structure and specify Node.js >=18.18.x requirement
  • Properly reference sibling ../tnt-core dependency

Code Quality & Best Practices

  • Consistency: All Node.js version references are aligned
  • Clarity: Documentation is clear, concise, and actionable
  • Maintenance: Removes stale files that could cause confusion
  • Standards: Follows established patterns for monorepo documentation

Security & Performance

  • No security concerns: Changes are purely documentary and configuration
  • No performance impact: Changes affect development setup only
  • Node.js version: 18.18.x is a stable LTS release, appropriate choice

Minor Observations

  • Package manager policy section in README.md:101-103 is well-articulated
  • Good use of semantic commit message format
  • PR description clearly explains all changes

Recommendation

Approve and merge. This PR successfully achieves its stated objectives with no issues identified.


Job Run

@netlify
Copy link
Copy Markdown

netlify Bot commented Mar 3, 2026

Deploy Preview for tangle-cloud ready!

Name Link
🔨 Latest commit 41d116d
🔍 Latest deploy log https://app.netlify.com/projects/tangle-cloud/deploys/69a741f189429200084a05d0
😎 Deploy Preview https://deploy-preview-3136--tangle-cloud.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@drewstone drewstone merged commit 0af5700 into develop Mar 3, 2026
21 checks passed
@drewstone drewstone deleted the drew/config-readme-operator-layer-cleanup branch March 3, 2026 20:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant