docs: update README with current project state and Neo Feeder API endpoints (DOC-002) - #123
Merged
Merged
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.
Summary
Updates
README.mdto reflect the current project state and records the Neo Feeder API endpoints the project consumes:keyand the complete-record requirement), the two cloud REST transcript endpoints, and a dedicated GetDictionary schema-inspection subsection.Related issues
Fixes #120
Checklist
php -lpasses on all modified PHP filesnpm run buildsucceeds and committed assets are up to datephp spark routesshows correct new routes (if routes changed)vendor/bin/php-cs-fixer fixpasses (no style violations)vendor/bin/phpunitis green (if tests exist)dd(),var_dump(),console.log(),print_r(),exit()csrf_field()esc()Screenshot (if applicable)
N/A — documentation-only change.
Notes for reviewers
Markdown-only change:
README.md(+110/-9) plus the trackerdocs/IMPROVEMENTS.md(DOC-002 → implemented). No user-facing behaviour change, so no CHANGELOG entry. Markdown verified LF-only + no-BOM (CI markdown checks pass).