Skip to content

docs: rewrite README and add CONTRIBUTING for the current Forest positioning - #418

Merged
Gawtier merged 1 commit into
mainfrom
docs/readme-refresh
Oct 26, 2026
Merged

Gawtier merged 1 commit into
mainfrom
docs/readme-refresh

Conversation

@Gawtier

@Gawtier Gawtier commented Oct 26, 2026 •

Copy link
Copy Markdown
Contributor

Rewrites the README for the current Forest positioning (operational back office for regulated companies, v2 agents, AI/MCP) and adds a CONTRIBUTING guide.

  • Pitch, real quick start, requirements, documentation links to docs.forest.app
  • Architecture diagram and header banner as light/dark SVGs in assets/, generated from the brand toolchain (text outlined, no embedded font, no external bucket)
  • Removes the Discourse badge and community section: community.forestadmin.com is being sunset and redirected to https://forest.app/forms/support
  • CONTRIBUTING links to the organization SECURITY and CODE_OF_CONDUCT in ForestAdmin/.github (separate PR)

🤖 Generated with Claude Code

Note

Rewrite README for current Forest positioning and add CONTRIBUTING guide

Replaces the legacy product overview, feature catalog, screenshots, and community links in README.md with a Ruby-agent-focused README covering Rails installation, environment variables, requirements, architecture, and documentation links.

  • Adds CONTRIBUTING.md covering issue and security reporting, Ruby/bundle setup, test commands, RuboCop usage, Conventional Commits, and PR steps.
  • Adds light/dark header and architecture SVG assets in assets/ referenced by the README.
  • Risk: legacy README sections (feature catalog, screenshots, community links) are removed; check for external links pointing to those anchors.

Macroscope summarized a10127d.

…tioning

Pitch for regulated ops teams, real quick start, architecture diagram (light/dark SVG generated from the brand toolchain), and links to docs.forest.app. Drops the Discourse badge and community section: community.forestadmin.com is being sunset and redirected to forest.app/forms/support.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@qltysh

qltysh Bot commented Oct 26, 2026

Copy link
Copy Markdown

Qlty


Coverage Impact

This PR will not change total coverage.

🚦 See full report on Qlty Cloud »

🛟 Help
  • Diff Coverage: Coverage for added or modified lines of code (excludes deleted files). Learn more.

  • Total Coverage: Coverage for the whole repository, calculated as the sum of all File Coverage. Learn more.

  • File Coverage: Covered Lines divided by Covered Lines plus Missed Lines. (Excludes non-executable lines including blank lines and comments.)

    • Indirect Changes: Changes to File Coverage for files that were not modified in this PR. Learn more.

@Gawtier
Gawtier merged commit 87e78a7 into main Oct 26, 2026
33 checks passed
@Gawtier
Gawtier deleted the docs/readme-refresh branch October 26, 2026 14:59
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