Skip to content

Refresh README, badges and unified documentation wiki - #5

Merged
AronAxe merged 1 commit into
mainfrom
docs/readme-wiki-refresh
Oct 7, 2026
Merged

AronAxe merged 1 commit into
mainfrom
docs/readme-wiki-refresh

Conversation

@AronAxe

@AronAxe AronAxe commented Oct 7, 2026

Copy link
Copy Markdown
Owner

Requested documentation update

  • Preserve the user's original docs/images/graphpaper-header.svg and the README image markup unchanged (SHA-256 verified).
  • Rewrite the material below it into a download-first project overview with six linked badges: release, real quality-workflow status, Windows x64, source Python version, MIT license and wiki.
  • Remove duplicated version announcements and obsolete source-only installation emphasis. Keep screenshots and historical release notes without turning the README into a changelog.
  • Add a documentation index and 18 maintained guides covering setup, connections/reasoning, all three writing workflows, project folders, graph/JEV, author voice, humanizer/deslop, APA exports, privacy, troubleshooting, architecture, integrations, validation, development and packaging.
  • Add root contribution/security entry points and refresh the code-only source manifest.

Actual GitHub wiki

The previously uninitialized GitHub wiki has now been initialized and published at https://github.com/AronAxe/GraphPaper/wiki. It contains all 18 guides plus sidebar/footer navigation, generated from the repository documentation. Published wiki commit: a8707284ad9edcc5b2495852dbcb33dcccab1386.

The publisher uses normal authorized Git operations, never force-pushes, preserves unrelated pages, and detects independent edits to managed pages instead of overwriting them. A second publication was tested and made no changes. A documentation workflow validates and synchronizes these same pages on main.

Validation

  • 12 documentation-tool tests passed.
  • 21 maintained Markdown files checked; 176 local/heading/image link targets validated.
  • All six badge URLs returned HTTP 200 and valid SVG.
  • The live quality badge honestly reports the existing failing browser job on main; it is not an unconditional success graphic. Existing application CI failure predates this docs-only change.
  • Header image SHA-256 is unchanged: 80bfe7844f469ef2c3d63dd7ca2321d6c24ebed7f5c56555d797227e81a7955e.
  • The 158-file source manifest matches actual staged Git blobs.

No application/runtime files, executable assets, credentials or private project data are changed. The published application release remains v0.3.0.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 7, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-07T13:49:41.134337Z 1903bcc PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@AronAxe
AronAxe merged commit 3f226e1 into main Oct 7, 2026
11 of 12 checks passed

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 1903bccfd6

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

- name: Publish managed wiki pages without replacing independent edits
env:
GH_TOKEN: ${{ github.token }}
run: python scripts/docs_tool.py publish-wiki

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Bootstrap the initialized wiki before automatic publishing

On the first main-branch run, an initialized GitHub wiki already contains Home.md but has no .graphpaper-wiki.json; reconciliation() therefore rejects that page unless adopt_home=True. Because this workflow always invokes publish-wiki without --adopt-home, the initial publication fails before creating the manifest or any generated pages. Add an explicit one-time adoption/bootstrap path, such as a documented manual workflow input, before enabling routine publication.

Useful? React with 👍 / 👎.

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