doc: Replace README with elaborate reference documentation#101
Open
hanstrompert wants to merge 2 commits into
Open
doc: Replace README with elaborate reference documentation#101hanstrompert wants to merge 2 commits into
hanstrompert wants to merge 2 commits into
Conversation
hanstrompert
commented
Jun 1, 2026
hanstrompert
commented
Member
- Reframe the project as a "minimal reference implementation" rather than a sample UI
- Add table of contents, features list, and ASCII architecture diagram
- Document environment variables (backend, OAuth2/OIDC, UI toggles, CopilotKit agent)
- Add project layout, customization guide (menu, logo, translations, pages)
- Document npm scripts, Docker build/deploy, local Keycloak setup
- Cross-link breaking-changes.md, update-instructions.md, and translations/README.md
DutchBen
reviewed
Jun 1, 2026
| | `AO_STACK_STATUS_URL` | Endpoint that the stack-status widget polls. | | ||
| | `START_WORKFLOW_FILTERS` | Pipe-separated list of workflow categories to expose on the start page. Underscores are converted to spaces, e.g. `Create|Modify|Terminate`. | | ||
|
|
||
| ### Agent (CopilotKit) |
Collaborator
There was a problem hiding this comment.
The agent is removed for now
DutchBen
reviewed
Jun 1, 2026
| ├── pages/ # Next.js routes (pages router) | ||
| │ ├── _app.tsx # providers, menu, auth wiring | ||
| │ ├── index.tsx # WfoStartPage | ||
| │ ├── agent.tsx # CopilotKit chat page |
DutchBen
reviewed
Jun 1, 2026
|
|
||
| ## Building & deploying | ||
|
|
||
| The included `Dockerfile` produces a small two-stage image: |
Collaborator
There was a problem hiding this comment.
I'm not sure about this docker part. I haven't used that in a long while
- Reframe the project as a "minimal reference implementation" rather than a sample UI - Add table of contents, features list, and ASCII architecture diagram - Document environment variables (backend, OAuth2/OIDC, UI toggles, CopilotKit agent) - Add project layout, customization guide (menu, logo, translations, pages) - Document npm scripts, Docker build/deploy, local Keycloak setup - Cross-link breaking-changes.md, update-instructions.md, and translations/README.md
- Replace the ASCII architecture diagram with a Mermaid flowchart - Render integrations (backend, OIDC, agent) as labeled edges from the UI
DutchBen
force-pushed
the
doc/expand-readme
branch
from
bad5d3d to
1d83a6f
Compare
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.