Skip to content

docs: add OpenWiki documentation and manual refresh workflow - #1340

Open
grove wants to merge 2 commits into
masterfrom
openwiki-experiment
Open

grove wants to merge 2 commits into
masterfrom
openwiki-experiment

Conversation

@grove

@grove grove commented Oct 20, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add the generated Sesam Hub product-reference OpenWiki: 29 Markdown pages across architecture, concepts, configuration, integrations, operations, references, testing, and workflows.
  • Include Grounded Claims, page coverage, and completed-build metadata, plus managed agent navigation. The wiki distinguishes documented product semantics from runtime implementation evidence.
  • Include the existing repository-specific OpenWiki instructions and ignore rules.
  • Add a manual-only refresh workflow pinned to OpenWiki 0.7.2, with Responses API enabled for GPT-6.1 Sol tool calls. It opens a separate update PR and preserves completed pages after a partial failure.
  • Preserve the original reStructuredText documentation and existing build configuration.

Validation

  • Initial generation metadata reports complete, using gpt-6.1-sol.
  • Parsed all 22 generated JSON files; confirmed the recorded source baseline and absence of transient run state.
  • Checked generated file scope and obvious credential/private-key patterns.
  • Parsed the workflow YAML and verified manual dispatch, Responses API transport, the version pin, full checkout history, and partial-progress handling.
  • Staged whitespace checks passed.
  • No Sphinx build, regeneration, model API call, or GitHub Actions execution was performed while preparing this PR. Generated claims still require normal content review.

Workflow Setup

The following repository settings were not present during preparation and must be configured before using the refresh workflow:

  • Secret OPENAI_COMPATIBLE_API_KEY.
  • Variable OPENAI_COMPATIBLE_BASE_URL, pointing to the intended Azure OpenAI endpoint.
  • A deployment named gpt-6.1-sol at that endpoint, or adjust OPENWIKI_MODEL_ID to the actual deployment name.
  • OPENWIKI_LANGSMITH_API_KEY for any configured LangSmith connector, and LANGSMITH_API_KEY for tracing; configure or disable unused integration/tracing as appropriate.

Only setting names were checked. No credentials were read or configured.

@grove
grove requested a review from a team as a code owner October 20, 2026 18:12
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