Skip to content

Implemented new wiki sync strategy#42

Closed
Hackshaven wants to merge 1 commit intomainfrom
40-implementation-plan-branch-aware-wiki-sync-for-datavizhub
Closed

Implemented new wiki sync strategy#42
Hackshaven wants to merge 1 commit intomainfrom
40-implementation-plan-branch-aware-wiki-sync-for-datavizhub

Conversation

@Hackshaven
Copy link
Collaborator

This pull request introduces a new workflow for syncing the GitHub Wiki into the documentation build process, removes the dev container’s wiki mirroring logic, and updates documentation to reflect these changes. The most important changes are the addition of a GitHub Action for wiki sync, updates to Sphinx configuration to support Markdown wiki pages, and documentation updates to guide contributors on the new workflow.

Wiki Sync Workflow and Documentation Build Integration

  • Added a GitHub Action (.github/workflows/sync-wiki.yml) to automatically sync the GitHub Wiki into docs/source/wiki/ on pushes, PRs, a daily schedule, and manual triggers. Commits to the synced wiki occur only on main to keep history clean.
  • Updated Sphinx configuration (docs/source/conf.py) to support Markdown (myst_parser), include both .rst and .md sources, and mock heavy dependencies for smoother docs builds. [1] [2] [3]
  • Added myst-parser and sphinx as dependencies in pyproject.toml for local documentation builds.

Documentation and Contributor Guidance

  • Added a new CONTRIBUTING.md outlining branching workflow, code style, testing, PR, and release process.
  • Updated README.md, AGENTS.md, and docs/source/index.rst to describe the new CI-synced wiki workflow and remove references to the dev container wiki mirror. [1] [2] [3]
  • Added docs/source/contributing/wiki-sync.md to document the rationale and rules for the new wiki sync workflow.

Dev Container Cleanup

  • Removed all dev container wiki mirroring logic from .devcontainer/entrypoint.sh, simplifying container startup and eliminating the offline wiki sync feature.

…n the automatically generated documentation and to make it available for coding agents. Add myst-parser and sphinx dependencies to pyproject.toml
@Hackshaven Hackshaven self-assigned this Aug 19, 2025
@Hackshaven Hackshaven linked an issue Aug 19, 2025 that may be closed by this pull request
@Hackshaven Hackshaven closed this Aug 19, 2025
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.

Implementation Plan: Branch-Aware Wiki Sync for DataVizHub

1 participant