Skip to content

Verify the documentation against source and add a Console page#277

Open
omatheusmesmo wants to merge 2 commits into
mainfrom
docs/site-review-and-console
Open

Verify the documentation against source and add a Console page#277
omatheusmesmo wants to merge 2 commits into
mainfrom
docs/site-review-and-console

Conversation

@omatheusmesmo

Copy link
Copy Markdown
Owner

What

A full verification pass over the site documentation against the source, plus a new Console page.

Verified and corrected

Checked every concrete claim (config properties, endpoints, tool names, defaults) against the code and fixed:

  • pgvector reframed as durable embeddings, not the default (markdown is the @DefaultBean; the app ships hybrid)
  • the missing searchMemories tool and POST /api/admin/memory/consolidate endpoint
  • the six cognition stores miscount
  • the Telegram webhook path (/api/webhook/telegram)
  • the wrong context-TTL env var and non-existent TTS aliases
  • the Google token-vault framed as on by default (the app disables it)
  • stale API_USER_PASSWORD references

Depth and diagrams

Trimmed composition, cut the speculative skills roadmap, and added mermaid diagrams where they clarify (composition pipeline, skills lifecycle, storage reconcile-vs-migrate, Google OAuth flow).

New Console page

Documents the /console admin UI (setup wizard, memory/skills/cognition/config/schedule), with nav entries in both the Roq template and the Antora nav.

Notes

Both doc trees updated (site/content/ and the docs/ Antora mirror); regenerated via mvn -f docs/pom.xml verify with no config-includes drift. Two commits: the Console page, then the corrections.

Document the previously-undocumented /console server-rendered admin UI (setup wizard, memory/skills/cognition/config/schedule pages) as a new operator-level page, with nav entries in the Roq template and the Antora nav.

Signed-off-by: Matheus Oliveira <matheus.6148@gmail.com>
Checked every concrete claim (config properties, endpoints, tool names, defaults) against the code and fixed the errors found: pgvector reframed as durable embeddings rather than the default (markdown is the @DefaultBean; app ships hybrid); the missing searchMemories tool and POST /api/admin/memory/consolidate endpoint; the six cognition stores miscount; the Telegram webhook path (/api/webhook/telegram); the wrong context-TTL env var and non-existent TTS aliases; the Google token-vault framed as on by default (app disables it); and stale API_USER_PASSWORD references. Rebalanced depth (trimmed composition, cut the speculative skills roadmap) and added mermaid diagrams where they clarify (composition pipeline, skills lifecycle, storage reconcile-vs-migrate, Google OAuth flow).

Signed-off-by: Matheus Oliveira <matheus.6148@gmail.com>
@github-actions

Copy link
Copy Markdown
Contributor

🚀 Docs preview for 4c4ab09 is live:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant