docs: fix README package doc links

[charles-openclaw]

Summary

Fixes #83 by making the README's local documentation links resolvable in both the repository and the npm package.

• add the missing CONTRIBUTING.md linked from the README
• include SDK-REFERENCE.md and CONTRIBUTING.md in the package files list so npm README links resolve after publish

Verification

• node -e "const fs=require('fs'), path=require('path'); const files=['README.md']; let missing=[]; for (const file of files) { const text=fs.readFileSync(file,'utf8'); for (const m of text.matchAll(/\\[[^\\]]+\\]\\(([^)#][^)]+)\\)/g)) { const target=m[1].split('#')[0]; if (/^[a-z]+:/i.test(target)) continue; const resolved=path.resolve(path.dirname(file), target); if (!fs.existsSync(resolved)) missing.push(file+' -> '+m[1]); } } console.log('missing_relative_links='+missing.length); if (missing.length) { console.log(missing.join('\\n')); process.exit(1); }"
• npm pack --dry-run --json | jq -r '.[0].files[].path'
• git diff --check

No full test suite was run because this only adds documentation/package metadata for README-linked files.

---

Summary by cubic

Fixes #83 by making README documentation links resolve in both the repo and the published npm package. Adds the missing contributing guide and packages both docs with the release.

• Bug Fixes
  • Add CONTRIBUTING.md referenced by the README.
  • Include SDK-REFERENCE.md and CONTRIBUTING.md in package.json files so README links work after publish.

^{Written for commit ec0a785. Summary will update on new commits.}

Note

Add CONTRIBUTING.md and include SDK-REFERENCE.md in published npm package

• Adds CONTRIBUTING.md with development setup instructions and pull request expectations.
• Updates package.json to include SDK-REFERENCE.md and CONTRIBUTING.md in the files array so they are bundled in the published npm package.

^{Macroscope summarized ec0a785.}

Summary by CodeRabbit

• Documentation

  • Added contribution guidelines with development setup instructions and pull request best practices

• Chores

  • Updated package distribution to include contribution and reference documentation files

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 11fbb9b0-28f9-4a8e-a282-d8692f45757b

📥 Commits

Reviewing files that changed from the base of the PR and between d7c4cf7 and ec0a785.

📒 Files selected for processing (2)

• CONTRIBUTING.md
• package.json

---

Walkthrough

This PR adds CONTRIBUTING.md with development setup and pull request guidelines for the InsForge JavaScript SDK, and updates package.json to distribute the new file along with SDK-REFERENCE.md in the published npm package.

Changes

Contributing Documentation and Distribution

Layer / File(s)	Summary
Contributing guidelines and package publishing CONTRIBUTING.md, package.json	CONTRIBUTING.md outlines development environment setup (fork, clone, install, lint, typecheck, test) and pull request requirements (focused changes, tests, docs for public API changes, issue links). The files array in package.json is updated to include CONTRIBUTING.md and SDK-REFERENCE.md alongside dist for distribution in the published package.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A guide for those who wish to share,
With hopping tips and setup care,
Now packaged neat for all to see,
Contributing starts with clarity! ✨

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'docs: fix README package doc links' is vague and does not clearly convey the main changes: adding CONTRIBUTING.md and including docs in the npm package.	Consider a more specific title like 'docs: add CONTRIBUTING.md and include docs in npm package' to better reflect the actual changes.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Linked Issues check	✅ Passed	The PR successfully addresses issue #83 by adding CONTRIBUTING.md to the repository and updating package.json to include both SDK-REFERENCE.md and CONTRIBUTING.md in the published package files.
Out of Scope Changes check	✅ Passed	All changes are directly related to resolving issue #83: adding CONTRIBUTING.md and updating package.json's files list to ensure documentation links work in the published npm package.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[cubic-dev-ai]

No issues found across 2 files

_{Re-trigger cubic}