Skip to content

Update Outdated Developer Documentation & OpenAPI v1 Specification#134

Merged
benhalpern merged 1 commit into
mainfrom
update-outdated-docs
Jul 13, 2026
Merged

Update Outdated Developer Documentation & OpenAPI v1 Specification#134
benhalpern merged 1 commit into
mainfrom
update-outdated-docs

Conversation

@benhalpern

@benhalpern benhalpern commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

This PR updates the Forem developer documentation to bring it up to date:

  1. Updated OpenAPI Specs: Synchronized api_v1.json with the latest live version from the official Forem repository, upgrading spec paths from 33 to 52 endpoints (adds /api/agent_sessions, /api/billboards, /api/organizations, /api/segments, /api/surveys, and /api/trends).
  2. Converted Outdated Domains: Replaced absolute links pointing to docs.forem.com and developers.forem.com with robust relative Markdown links for compile-time validation.
  3. Removed Redundant Links: Cleaned up the self-referencing link in docs/frontend/instant-click.md.
  4. Modernized Setup References: Updated postgresql.md references to target current Ubuntu LTS versions (22.04 / 24.04) and updated PostgreSQL docs URLs to current.
  5. Rewrote CI/CD Documentation: Updated deploying.md to document the current GitHub Actions pipelines (ci.yml and cd.yml), detailing KnapsackPro 15-node parallelization and Heroku CD setups.

Verification:

  • Successfully compiled the production build using yarn build.
  • Ran linter validation via yarn run api-docs:lint.

View with Codesmith Autofix with Codesmith
Need help on this PR? Tag /codesmith with what you need. Autofix is disabled.

@benhalpern
benhalpern requested a review from a team as a code owner July 13, 2026 14:09
@benhalpern
benhalpern merged commit 443f06f into main Jul 13, 2026
4 of 6 checks passed
@benhalpern
benhalpern deleted the update-outdated-docs branch July 13, 2026 14:10
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.

1 participant