Move reference documentation to docs/references/#1572
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1572 +/- ##
===========================================
+ Coverage 47.81% 64.91% +17.10%
===========================================
Files 382 372 -10
Lines 8525 8382 -143
Branches 3159 3123 -36
===========================================
+ Hits 4076 5441 +1365
+ Misses 3070 2086 -984
+ Partials 1379 855 -524
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
e8147b0 to
ce8a54d
Compare
ce8a54d to
5337aa7
Compare
xiazcy
approved these changes
Mar 11, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Move several sections from the root README into standalone reference documents under
docs/references/. This keeps the README focused on getting started and high-level overview, while making technical reference material easy to find in a dedicated location.docs/references/minimum-requirements.mddocs/references/health-check.mddocs/references/logging.mddocs/references/default-connection.mddocs/references/security.mddocs/development.md,docs/guides/deploy-to-ecs-fargate.md, anddocs/references/default-connection.mddocs/README.mddocs/README.mdtable of contentsValidation
Related Links
Check List
pnpm checksto ensure code compiles and meets standards.pnpm testto check if all tests are passing.Changelog.md.