You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
GitHub Wiki serves its purpose as a documentation tool but migrating to a static website builder like Jekyll, Hugo, or Sphinx could provide us with greater flexibility, better user experience, and more robust features.
With a static website, we can provide a searchable interface, multi-language support, integrate analytics to understand user engagement, and even version our documentation alongside code releases.
Version control and community engagement are 2 big pieces to care for as a maintainer.
I am proposing we migrate our readme/wiki docs to a static website.
Steps
Evaluate static site generators (Jekyll, MKDocs, Hugo, Sphinx, etc.) for compatibility with our needs.
Create a prototype site for initial review and feedback. - in a fork
Move existing Wiki content to the chosen static site builder. - (merge docs PR)
Set up CI/CD pipeline for automated builds and deployments. - (part of PR, GitHub actions to build GitHub pages)
Update README and other relevant project files to point to the new documentation site.
turn wiki off after a successful migration.
This issue is to hear agreements/disagreement with the proposal and then, decide on the tool. I have my choice, but will leave it for others to chime in :)
The text was updated successfully, but these errors were encountered:
GitHub Wiki serves its purpose as a documentation tool but migrating to a static website builder like Jekyll, Hugo, or Sphinx could provide us with greater flexibility, better user experience, and more robust features.
With a static website, we can provide a searchable interface, multi-language support, integrate analytics to understand user engagement, and even version our documentation alongside code releases.
Version control and community engagement are 2 big pieces to care for as a maintainer.
I am proposing we migrate our readme/wiki docs to a static website.
Steps
This issue is to hear agreements/disagreement with the proposal and then, decide on the tool. I have my choice, but will leave it for others to chime in :)
The text was updated successfully, but these errors were encountered: