Skip to content

Add GitHub wiki content and sync tooling; simplify CI artifact handling#7

Open
knoxhack wants to merge 1 commit into
mainfrom
codex/create-github-wiki-for-echo-mod-stack-3tpi5t
Open

Add GitHub wiki content and sync tooling; simplify CI artifact handling#7
knoxhack wants to merge 1 commit into
mainfrom
codex/create-github-wiki-for-echo-mod-stack-3tpi5t

Conversation

@knoxhack
Copy link
Copy Markdown
Owner

@knoxhack knoxhack commented May 9, 2026

Motivation

  • Provide an on-repo source-of-truth for the project wiki and document the process to publish it to the GitHub Wiki repository.
  • Add a small helper to make ongoing wiki synchronization easy and visible in the README.
  • Simplify and adjust the CI build workflow to change how release verification and artifact collection are handled.

Description

  • Added a wiki/ collection of markdown pages (Home.md, Getting-Started.md, Architecture.md, Addon-Development.md, Build-and-Release.md, Modules-and-Versions.md, Progression-Guide.md, Troubleshooting.md, Lore-and-World-Canon.md) to serve as the source-of-truth for the GitHub Wiki.
  • Added docs/wiki_publish.md with step-by-step instructions for bootstrapping and syncing the Wiki, and updated README.md to reference the new Wiki publishing guidance.
  • Added an executable helper tools/sync_wiki.sh to copy wiki/*.md into a checked-out Echo.wiki repo and print the next git steps.
  • Modified .github/workflows/build.yml to adjust the release/verification and artifact collection steps (changed how ./gradlew verifyEchoRelease and artifact collection are invoked and removed the previous artifact upload/summary steps in favor of the updated collection flow).

Testing

  • No automated test runs were included in this PR; CI workflow changes will be exercised when the repository's GitHub Actions run on the updated build workflow. }

Codex Task

Copy link
Copy Markdown

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

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: 15b8baf9b3

ℹ️ 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".

Comment thread tools/sync_wiki.sh
fi

mkdir -p "$wiki_repo"
cp -f wiki/*.md "$wiki_repo/"
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Mirror wiki deletions when syncing

The helper is documented as an ongoing wiki sync tool, but this copy step only adds or overwrites files and never removes markdown pages that were deleted or renamed in wiki/. In that scenario, stale pages remain in Echo.wiki and continue to be published, so the wiki can drift from the repo source-of-truth over time. Consider using a delete-aware sync (for example rsync --delete or an explicit cleanup pass) so removals are propagated.

Useful? React with 👍 / 👎.

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant