docs: fix headings, numbering, and formatting in API.md#63
Open
AKV2703 wants to merge 1 commit into
Open
Conversation
nikhil-3210
approved these changes
May 23, 2026
There was a problem hiding this comment.
Pull request overview
This PR updates docs/API.md to correct section numbering and improve Markdown heading structure/formatting across multiple API module sections.
Changes:
- Renumbered API sections to maintain consistent sequential numbering (e.g., Tree Types → 10, Project Management → 11, etc.).
- Adjusted heading levels within the Tree Scans and Scan Batches sections to better reflect the document hierarchy (e.g., converting mis-leveled
##subsections to###/####/#####). - Added minor spacing/formatting tweaks around section breaks to improve readability.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - integration tests create and clean up their own data | ||
|
|
||
| ### 16.11 How To Run Adopter Tests | ||
| ### 17.11 How To Run Adopter Tests |
Comment on lines
3518
to
3520
| Run unit tests only: | ||
|
|
||
| npm test -- tests/unit/adopters.test.ts |
Comment on lines
3522
to
3524
| Run integration tests only: | ||
|
|
||
| npm test -- tests/integration/adopters.test.ts |
| ## 17.7 Error Handling | ||
| ### 19.7 Error Handling | ||
|
|
||
| Uses centralized error middleware. |
sandaliSS
approved these changes
May 23, 2026
| - integration tests create and clean up their own data | ||
|
|
||
| ### 16.11 How To Run Adopter Tests | ||
| ### 17.11 How To Run Adopter Tests |
| ## 17.7 Error Handling | ||
| ### 19.7 Error Handling | ||
|
|
||
| Uses centralized error middleware. |
| --- | ||
|
|
||
| ## 15.2 Architecture Flow | ||
| ### 16.2 Architecture Flow |
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.
No description provided.