Skip to content

docs: refresh setup and contribution guides - #1

Draft
mienetic wants to merge 2 commits into
mainfrom
agent/update-documentation
Draft

mienetic wants to merge 2 commits into
mainfrom
agent/update-documentation

Conversation

@mienetic

Copy link
Copy Markdown
Owner

What changed

  • Added the real clone URL and reproducible npm ci setup steps to the README.
  • Documented the core TypeScript and Rust validation commands used by CI.
  • Replaced <owner> placeholders in the contribution guide with mienetic/toolpulse links.
  • Clarified prerequisites, code-style checks, comments guidance, and the pull-request workflow.

Why

The contributor guide contained placeholder repository links, and the README did not provide a complete clone-to-run workflow or validation commands. These changes align the documentation with package-lock.json, the npm-based CI workflow, and the current repository location.

Impact

New contributors can clone, install, validate, and report issues using copy-pasteable commands and working links.

Validation

  • Re-read both files from the branch after updating them.
  • Cross-checked setup and validation commands against .github/workflows/ci.yml and package-lock.json.
  • Documentation-only change; no application build was run.

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