docs: update readme according to new standard#240
Open
Conversation
Signed-off-by: Kevin Szuchet <31735779+kevinszuchet@users.noreply.github.com>
kevinszuchet
approved these changes
Jan 29, 2026
|
|
||
| Before running this service, ensure you have the following installed: | ||
|
|
||
| - **Node.js**: Version 18.x (LTS recommended) |
Contributor
There was a problem hiding this comment.
Does this still apply? Or is it possible to use a newer version of Node?
| - [Testing](#testing) | ||
| - [Running Tests](#running-tests) | ||
| - [Test Structure](#test-structure) | ||
| - [Additional Documentation](#additional-documentation) |
Contributor
There was a problem hiding this comment.
WDYT about taking the AI Agent Context section out from the Additional Documentation so the README "complies" with our template?
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
2 participants
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.
This PR updates the project README to follow the agreed standards in order to normalize all documentation across the organization.