docs: restructure public docs#3
Merged
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR restructures the public documentation for fincrawl, making the README shorter and moving contributor/release details into more focused docs while clarifying Intercom/Fin wording.
Changes:
- Reorganized README around install, quick start, snapshots, commands, docs, contributing, and security.
- Added distribution/release documentation and a compact pull request template.
- Updated Fin references to describe Intercom-exposed Fin participation metadata.
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
README.md |
Reframes top-level docs around user-facing setup, commands, snapshots, and navigation. |
CONTRIBUTING.md |
Moves validation, local run, data boundary, PR, and release references into clearer sections. |
.github/pull_request_template.md |
Adds PR checklist for verification, data boundary, and release-note relevance. |
docs/distribution.md |
Adds release, CI, artifact, and security model documentation. |
docs/architecture.md |
Clarifies Intercom workspace and Fin participation metadata scope. |
docs/roadmap.md |
Updates current release automation wording. |
docs/references/intercom-api.md |
Clarifies Fin metadata wording in Intercom sync guidance. |
docs/runbooks/open-source-readiness.md |
Renames readiness checklist and points release mechanics to Distribution. |
skills/fincrawl/SKILL.md |
Updates skill description for Intercom-exposed Fin metadata. |
skills/fincrawl/references/reads.md |
Clarifies search guidance around Intercom-exposed Fin status. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Verification
Data Boundary
Complexity
Summary by cubic
Restructured public docs to center on install, quick start, snapshots, and core CLI flows, and added a compact PR template and release/distribution guide. Clarifies Fin as Intercom-exposed participation metadata and keeps tenant data out of the repo.
New Features
docs/distribution.mdwith release flow, versioning, and security model..github/pull_request_template.mdwith verification and data-boundary checks.Refactors
README.mdaround Install, Quick Start, Snapshots, Commands, and Docs navigation.CONTRIBUTING.md; moved release details todocs/distribution.md.docs/architecture.md, Intercom API reference, roadmap, OSS readiness runbook, and skill guides.Written for commit f5cc2c0. Summary will update on new commits. Review in cubic