Conversation
- Fix the config example to show the full settings.website nesting (services/websocket) and add servicesPrefix, matching config/sample.json. - Correct _production_.json to _production.json and clarify that the production website build uses npm (website/build.sh) while dev uses Bun. - Note the 16-char JWT secret minimum (32+ recommended). - Sync the Portuguese README with the English one. - Update ui/README to Bun install/watch. - Add docs/configuration.md and docs/api.md (EN + PT) documenting the sample configuration keys and the local HTTP/WebSocket routes, distinguishing implemented, disabled and placeholder routes. - Add website/README.md describing the React/Redux/Vite front-end.
LilianaTS
force-pushed
the
docs/align-with-code
branch
from
September 1, 2026 22:05
29a996f to
6d520b3
Compare
There was a problem hiding this comment.
🟡 Changes recommended
A few new/updated docs contain verified inconsistencies/ambiguities with the repo’s current files (e.g., Bun “required” wording, config path wording, and db.default.port sample type).
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Updates ReAuthKit’s documentation to match the current configuration structure, build tooling, and the implemented local HTTP/WebSocket surface (including EN + PT variants), plus adds standalone configuration/API reference docs.
Changes:
- Align README examples with
config/sample.json(notablysettings.website.*nesting) and clarify production vs development front-end tooling. - Add full configuration reference docs (EN + PT) covering every key in
config/sample.json. - Add API/extension reference docs (EN + PT) enumerating routes, status (implemented/disabled/placeholder), and core lifecycle hooks.
File summaries
| File | Description |
|---|---|
| website/README.md | New website module README with Bun dev steps and npm-based production build notes. |
| ui/README.md | Switch backoffice UI instructions to Bun-based install/watch commands. |
| README.md | Update root README configuration and production sections; link to new reference docs. |
| README-pt_PT.md | Sync Portuguese README with updated EN structure, terminology, and steps. |
| docs/configuration.md | New full configuration key reference for config/sample.json (EN). |
| docs/configuration-pt_PT.md | New full configuration key reference for config/sample.json (PT). |
| docs/api.md | New code-first route + extension reference (EN). |
| docs/api-pt_PT.md | New code-first route + extension reference (PT). |
Review details
- Files reviewed: 8/8 changed files
- Comments generated: 5
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| 2. De acordo com o seu ambiente de desenvolvimento, altere o arquivo `.json` na chave `settings.api.endpoint` para o endereço correto dos serviços Netuno, exemplo: | ||
| > Pode alterar o nome da aplicação modificando o nome da pasta e o parâmetro de configuração `name`. | ||
|
|
||
| 2. No ficheiro de configuração selecionado, defina `settings.website.services.prefix` e `settings.website.websocket` com os endpoints corretos do Netuno. Por exemplo: |
| > You can change the application name by changing the folder name and the `name` configuration parameter. | ||
|
|
||
| 2. According to your development environment, change the `.json` file in the `settings` key to the correct addresses of the Netuno app URLs, example: | ||
| 2. In the selected configuration file, set `settings.website.services.prefix` and `settings.website.websocket` to the correct Netuno endpoints. For example: |
| | --- | --- | --- | | ||
| | `db.default.engine` | `pg` | Motor da base de dados; o esquema desta aplicação destina-se ao PostgreSQL. | | ||
| | `db.default.host` | `localhost` | Servidor da base de dados. | | ||
| | `db.default.port` | `5432` | Porta da base de dados. | |
| | --- | --- | --- | | ||
| | `db.default.engine` | `pg` | Database engine; this application schema targets PostgreSQL. | | ||
| | `db.default.host` | `localhost` | Database hostname. | | ||
| | `db.default.port` | `5432` | Database port. | |
|
|
||
| ### Installation | ||
|
|
||
| Bun is required to install the dependencies. |
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.
What
Brings the ReAuthKit documentation in line with the current code and configuration.
README (EN + PT)
settings.websitenesting forservices/websocketand addservicesPrefix, matchingconfig/sample.json(the previous example placed these keys at the wrong level)._production_.jsonto_production.json.website/build.shrunsnpm install --force+npm run build), while development uses Bun.settings.api.endpoint).ui/README.md: usebun install/bun run watch.New reference docs
docs/configuration.md/docs/configuration-pt_PT.md: every sample configuration key.docs/api.md/docs/api-pt_PT.md: the local HTTP/WebSocket routes and lifecycle hooks, distinguishing implemented, disabled, and placeholder routes.website/README.md: describes the React/Redux/Ant Design/Vite front-end.Documentation only — no code or configuration changes.