Skip to content

Conversation

@khvn26
Copy link
Member

@khvn26 khvn26 commented Dec 31, 2025

Thanks for submitting a PR! Please check the boxes below:

  • I have added information to docs/ if required so people know about the feature!
  • I have filled in the "Changes" section below?
  • I have filled in the "How did you test this code" section below?
  • I have used a Conventional Commit title for this Pull Request

Changes

In this PR, we attempt to revamp our developer documentation, and make it accessible for human contributors and LLM-based agents alike.

  • Add AGENTS.md
  • Add missing developer documentation
  • Refresh CONTRIBUTING.md
  • Refresh the PR template
  • Import developer docs and CONTRIBUTING.md to docs.flagsmith.com

How did you test this code?

To check changes to docs.flagsmith.com, observed the local Docusaurus build with make -C docs serve.

#6451 was generated by Claude (Opus 4.5) on top of this branch. It wasn't a one-shot, but I did observe Claude consistently following the guidelines, particularly using the Make targets and adhering to the test naming pattern documented in api/README.md.

- Add missing developer documentation
- Refresh CONTRIBUTING.md
- Refresh the PR template
- Import developer docs and CONTRIBUTING.md to docs.flagsmith.com
@khvn26 khvn26 requested review from a team as code owners December 31, 2025 07:05
@khvn26 khvn26 requested review from Holmus and Zaimwa9 and removed request for a team December 31, 2025 07:05
@cursor
Copy link

cursor bot commented Dec 31, 2025

You have run out of free Bugbot PR reviews for this billing cycle. This will reset on January 10.

To receive reviews on all of your PRs, visit the Cursor dashboard to activate Pro and start your 14-day free trial.

@vercel
Copy link

vercel bot commented Dec 31, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
docs Ready Ready Preview, Comment Jan 7, 2026 11:16am
2 Skipped Deployments
Project Deployment Review Updated (UTC)
flagsmith-frontend-preview Ignored Ignored Preview Jan 7, 2026 11:16am
flagsmith-frontend-staging Ignored Ignored Preview Jan 7, 2026 11:16am

@github-actions github-actions bot added front-end Issue related to the React Front End Dashboard api Issue related to the REST API docs Documentation updates and removed docs Documentation updates labels Dec 31, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Dec 31, 2025

Docker builds report

Image Build Status Security report
ghcr.io/flagsmith/flagsmith-api:pr-6448 Finished ✅ Results
ghcr.io/flagsmith/flagsmith-api:pr-6448 Finished ✅ Results
ghcr.io/flagsmith/flagsmith-private-cloud:pr-6448 Finished ✅ Results
ghcr.io/flagsmith/flagsmith:pr-6448 Finished ✅ Results
ghcr.io/flagsmith/flagsmith:pr-6448 Finished ✅ Results
ghcr.io/flagsmith/flagsmith-api-test:pr-6448 Finished ✅ Skipped
ghcr.io/flagsmith/flagsmith-e2e:pr-6448 Finished ✅ Skipped
ghcr.io/flagsmith/flagsmith-api:pr-6448 Finished ✅ Results
ghcr.io/flagsmith/flagsmith:pr-6448 Finished ✅ Results
ghcr.io/flagsmith/flagsmith-private-cloud:pr-6448 Finished ✅ Results
ghcr.io/flagsmith/flagsmith-frontend:pr-6448 Finished ✅ Results

@codecov
Copy link

codecov bot commented Dec 31, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 98.07%. Comparing base (2d208b1) to head (6888ad3).
⚠️ Report is 36 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #6448   +/-   ##
=======================================
  Coverage   98.06%   98.07%           
=======================================
  Files        1292     1294    +2     
  Lines       46509    46537   +28     
=======================================
+ Hits        45611    45639   +28     
  Misses        898      898           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@khvn26 khvn26 requested a review from Copilot December 31, 2025 07:10
@github-actions github-actions bot added docs Documentation updates and removed docs Documentation updates labels Dec 31, 2025
@khvn26 khvn26 changed the title docs: Add developer documentations, AGENTS.md docs: Add developer documentation, AGENTS.md Dec 31, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

khvn26 and others added 3 commits December 31, 2025 11:30
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@github-actions github-actions bot added docs Documentation updates and removed docs Documentation updates labels Dec 31, 2025
@github-actions github-actions bot added docs Documentation updates and removed docs Documentation updates labels Dec 31, 2025
Copy link
Contributor

@Zaimwa9 Zaimwa9 left a comment

Choose a reason for hiding this comment

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

A first few comments before reading the details

@Zaimwa9
Copy link
Contributor

Zaimwa9 commented Jan 2, 2026

@gagantrivedi by the way the hook i was mentioning https://code.claude.com/docs/en/hooks#precompact-input

@github-actions github-actions bot added docs Documentation updates and removed docs Documentation updates labels Jan 2, 2026
Zaimwa9
Zaimwa9 previously approved these changes Jan 7, 2026
Copy link
Contributor

@Zaimwa9 Zaimwa9 left a comment

Choose a reason for hiding this comment

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

Happy to prove and get going with it

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 14 out of 15 changed files in this pull request and generated 10 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions github-actions bot added docs Documentation updates and removed docs Documentation updates labels Jan 7, 2026
@github-actions github-actions bot added docs Documentation updates and removed docs Documentation updates labels Jan 7, 2026
@khvn26 khvn26 requested a review from Zaimwa9 January 7, 2026 11:17
@matthewelwell matthewelwell merged commit 7dfc785 into main Jan 7, 2026
30 checks passed
@matthewelwell matthewelwell deleted the docs/agents-and-humans branch January 7, 2026 14:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api Issue related to the REST API docs Documentation updates front-end Issue related to the React Front End Dashboard

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants