docs: add API implementation status inventory - #26
Merged
priscaenoch merged 1 commit intoJul 18, 2026
Conversation
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.
Closes #11
Summary
This pull request adds
docs/STATUS.md, a documentation file that provides a complete inventory of the TypeScript API surface undersrc/api.The goal is to make it clear which modules are production-ready, experimental, or backed by mock/stub implementations, while also defining a clearer boundary between the core explorer backend and specialized feature areas.
What was added
src/api.Why this change is needed
The backend currently exposes a very large and mixed API surface. Some modules use real execution paths, while others are incomplete, experimental, unmounted, or depend on hardcoded and mock data.
Without a centralized status document, it is difficult for maintainers to determine:
docs/STATUS.mdprovides an operational map of the current API surface and makes these boundaries explicit.Scope
This is a documentation-only change.
No application source code, tests, configuration files, or dependencies were modified.
Validation
src/api.docs/STATUS.mdis the only changed file.