Skip to content

docs: restructure public docs#3

Merged
altaywtf merged 1 commit into
mainfrom
docs/public-docs-structure
May 17, 2026
Merged

docs: restructure public docs#3
altaywtf merged 1 commit into
mainfrom
docs/public-docs-structure

Conversation

@altaywtf

@altaywtf altaywtf commented May 17, 2026

Copy link
Copy Markdown
Member

Summary

  • Restructure the README around install, quick start, snapshots, commands, and docs navigation
  • Move contributor and release mechanics into Contributing and Distribution
  • Clarify Fin wording as Intercom-exposed conversation metadata instead of a separate provider
  • Add a compact pull request template for verification and tenant-data boundary checks

Verification

  • ./scripts/verify
  • ./scripts/release-check
  • go run ./cmd/fincrawl guard --json
  • Markdown local link check
  • stale wording/residue scan

Data Boundary

  • No tenant credentials, identifiers, real transcript data, generated snapshots, logs, reports, screenshots, or transcript-derived examples added.

Complexity

  • Reduced: top-level README is shorter and release/contributor detail has a clearer home.

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

    • Added docs/distribution.md with release flow, versioning, and security model.
    • Added .github/pull_request_template.md with verification and data-boundary checks.
  • Refactors

    • Rewrote README.md around Install, Quick Start, Snapshots, Commands, and Docs navigation.
    • Moved contributor setup/validation to CONTRIBUTING.md; moved release details to docs/distribution.md.
    • Clarified Fin wording as Intercom-exposed participation metadata across docs.
    • Minor updates to 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

Copilot AI review requested due to automatic review settings May 17, 2026 16:01

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 10 files

Re-trigger cubic

@altaywtf
altaywtf merged commit b2ea106 into main May 17, 2026
7 checks passed
@altaywtf
altaywtf deleted the docs/public-docs-structure branch May 17, 2026 16:12
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.

2 participants