ethanbienstock opened a new issue, #38496:
URL: https://github.com/apache/superset/issues/38496

   ## Problem
   
   GitHub wiki repositories are separate git repos with no built-in mechanism 
to keep them aligned with the main code repository. This creates several 
challenges:
   
   - **No PR review for wiki changes** — Wiki edits are pushed directly with no 
review process, making it easy for incorrect or outdated documentation to slip 
in.
   - **No visibility into wiki changes** — Wiki commits don't appear in the 
main repo's history, so documentation changes are easily missed during 
development.
   - **Documentation drift** — As features are added or changed in the code 
repo, corresponding wiki updates can be forgotten since they require a separate 
workflow.
   - **No CI/CD integration** — Wiki changes can't trigger or be validated by 
the same pipelines that govern code changes.
   
   ## Proposed Solution
   
   Add a `wiki/` directory to the main repository and a GitHub Actions workflow 
that automatically syncs its contents to the wiki repo when changes are merged 
to `main`. This allows wiki changes to go through the same PR review process as 
code changes, ensuring documentation stays aligned and reviewed.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to