Skip to content

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

Merged
Gawtier merged 2 commits into
mainfrom
docs/readme-refresh
Oct 26, 2026
Merged

Gawtier merged 2 commits 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 and add CONTRIBUTING for current Forest positioning

Replaces the old product overview in the README with a Python-agent-focused one, including Django and Flask quick-start examples, configuration guidance, package badges, and monorepo package details.

  • Adds new light and dark architecture and header SVG assets under assets/.
  • Adds a CONTRIBUTING guide covering issue and security reporting, Poetry setup, test commands, pre-commit requirements, and Conventional Commits.

Macroscope summarized 31fe72b.

…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>
Comment thread README.md Outdated
Comment thread README.md
Drop FOREST_CUSTOMIZE_FUNCTION from the minimal Django setup (a missing module stops the agent) and explain it below; add the missing imports. Flask: load the secrets into app.config, which is the only place FlaskAgent reads them, and define db with flask-sqlalchemy.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@Gawtier
Gawtier merged commit 9f02c09 into main Oct 26, 2026
59 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