Docs hardening: security, quickstart cleanup, and repo guardrails

[aviyashchin]

Summary

Implements issue #42 hardening work in a single delivery pass.

What changed

• Removed misleading third-party template residue from README.md.
• Added a documentation map and fixed community/support links.
• Rewrote Security.md with repository-accurate disclosure guidance (huntr + security@subconscious.ai).
• Replaced api/README.md with a canonical quickstart using placeholder secrets, explicit /api/v1 and /api/v2 notes, and HTTP error-handling examples.
• Added CONTRIBUTING.md contribution flow and checks.
• Added .github/pull_request_template.md docs/security checklist.
• Added .github/workflows/docs-checks.yml:
  • blocking markdown link check
  • non-blocking markdown style lint
• Added .gitignore baseline.
• Added AGENTS.md repository contributor guidelines.
• Clarified antler_hackathon.md as extended reference and fixed an inline TODO typo.

Validation

• Secret-pattern grep checks on edited docs.
• Empty-link scan on edited markdown files.
• Manual endpoint/path consistency review across updated docs.

Refs #42

[aviyashchin]

Approved

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Disabled knowledge base sources:

• Linear integration is disabled

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between f21f8c5 and fab8dd3.

📒 Files selected for processing (9)

• .github/pull_request_template.md
• .github/workflows/docs-checks.yml
• .gitignore
• AGENTS.md
• CONTRIBUTING.md
• README.md
• Security.md
• antler_hackathon.md
• api/README.md

---

Walkthrough

The PR establishes repository infrastructure including a GitHub Actions workflow for documentation checks, a pull request template, contribution guidelines, and project guidance documentation. It also refactors API documentation into step-by-step instructions with versioning notes, updates security policies, and refreshes the README with a documentation map.

Changes

Cohort / File(s)	Summary
GitHub Configuration .github/pull_request_template.md, .github/workflows/docs-checks.yml, .gitignore	Adds PR template with summary, issue reference, and documentation checklist. Introduces two-job GitHub Actions workflow for link validation (blocking) and Markdown linting (non-blocking) on PRs and pushes. Adds standard ignore rules for macOS, editors, Python, Node, and environment files.
Contribution Guidelines AGENTS.md, CONTRIBUTING.md	Introduces comprehensive project guidance covering structure, build/test commands, coding style, testing, commit/PR workflows, and security tips. Adds contribution documentation outlining scope (Markdown files), branch strategy, commit conventions, and PR checklist with emphasis on small, focused changes.
Core Documentation Updates README.md, Security.md, antler_hackathon.md, api/README.md	Removes badge blocks from README and adds Documentation Map. Simplifies Security.md vulnerability reporting to two-step huntr/email workflow. Corrects comment typo in antler_hackathon.md. Completely reworks api/README.md with five step-by-step API instructions (Configure Access, Validate Causality, Generate Attributes, Run Experiment, Retrieve Results), mixed API v1/v2 endpoints, Python/httpx examples, and Troubleshooting section.

Poem

🐰 Hops of joy through organized halls,
Templates, workflows, and contribution calls,
API steps now clear as morning dew,
Documentation gleaming, shiny and new!
Security gates and guidelines so tight,
This repo now runs just right! ✨

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch 42-dummy-pr-link

---

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.}