Skip to content

docs: add npm publishing info and ci-entry details to contributing page#49

Merged
parse merged 1 commit intomainfrom
docs/contributing-updates
Mar 8, 2026
Merged

docs: add npm publishing info and ci-entry details to contributing page#49
parse merged 1 commit intomainfrom
docs/contributing-updates

Conversation

@parse
Copy link
Contributor

@parse parse commented Mar 8, 2026

Summary

  • Replaced the bullet-list package overview with a table that includes npm package names and clarifies which packages are public vs private
  • Added a "CI entry point" section explaining how erode-ci is invoked by CI integrations
  • Minor package-lock.json cleanup

Test plan

  • Verify the contributing page renders correctly on the docs site
  • Confirm no broken links

Summary by CodeRabbit

  • Documentation
    • Updated contributing guide with a structured package reference table for improved clarity
    • Added CI entry point documentation detailing system invocation and available entrypoint scripts

@coderabbitai
Copy link

coderabbitai bot commented Mar 8, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5a49ddc4-922b-4d3e-b9fd-bb48e39d1d4e

📥 Commits

Reviewing files that changed from the base of the PR and between 67060fc and f85417d.

⛔ Files ignored due to path filters (1)
  • package-lock.json is excluded by !**/package-lock.json
📒 Files selected for processing (1)
  • packages/web/src/content/docs/docs/contributing.md

📝 Walkthrough

Walkthrough

The contributing documentation is updated to replace a package list with a structured table format and introduces a new section detailing CI entry point configuration and script locations.

Changes

Cohort / File(s) Summary
Documentation Update
packages/web/src/content/docs/docs/contributing.md
Converts package information from bullet list to table format with Package, npm, and Description columns; adds new CI entry point section documenting erode-ci invocation and entrypoint script file locations.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A table neat, so clean and bright,
Where packages dance in rows just right!
CI scripts gathered, all in place,
Documentation blooms with grace!

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch docs/contributing-updates

Comment @coderabbitai help to get the list of available commands and usage tips.

@parse parse merged commit ccaf5b2 into main Mar 8, 2026
8 of 9 checks passed
@parse parse deleted the docs/contributing-updates branch March 8, 2026 09:41
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