Skip to content

Conversation

@marcusquinn
Copy link
Contributor

Add Wiki Documentation and Automatic Sync

Description

This PR addresses issue #50 by adding documentation in a .wiki folder and setting up automatic synchronization to the GitHub wiki.

Changes Made

  1. Created a .wiki folder containing:
    • 75+ documentation articles converted from HTML to Markdown
    • Navigation structure with Home.md and _Sidebar.md
    • Conversion scripts to update documentation from HTML sources
  2. Added a GitHub Action workflow to automatically sync the .wiki folder to the GitHub wiki whenever changes are pushed to the main branch

Benefits

  • Documentation is version-controlled alongside the code
  • Documentation changes can be reviewed in PRs
  • Automatic sync to GitHub wiki ensures documentation is always up-to-date
  • Markdown format is more readable and easier to maintain than HTML
  • Conversion scripts make it easy to update documentation from HTML sources

How to Use

  1. Make changes to files in the .wiki folder
  2. Submit a PR for review
  3. Once merged to main, the GitHub Action will automatically sync the changes to the GitHub wiki

Testing

  • The GitHub Action has been tested locally and works as expected
  • The documentation has been reviewed for formatting and readability

Fixes #50

Copy link
Collaborator

@superdav42 superdav42 left a comment

Choose a reason for hiding this comment

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

  • Please remove the unrelated domain mapping changes.
  • There's some docs that can be removed such as managing WP Ultimo license.
  • Run a search replace for WP Ultimo -> WP Multisite WaaS

@marcusquinn
Copy link
Contributor Author

@superdav42 I don't suppose you downloaded all the images from help.wpultimo.com, too?

@superdav42
Copy link
Collaborator

@superdav42 I don't suppose you downloaded all the images from help.wpultimo.com, too?

I thought I ran a script that would make a complete site mirror. It pulled a few images but not many. It's possible they didn't exist on the site at the time I ran it.

Some might be on the internet archive

@marcusquinn
Copy link
Contributor Author

been trying to pull them from archive.org but most seem to be missing - oh well, someone can make nicer high-res ones

@marcusquinn
Copy link
Contributor Author

Site Sucker's good for these things in future.

Copy link
Collaborator

@superdav42 superdav42 left a comment

Choose a reason for hiding this comment

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

Looks good. More clean up will be needed but this make it available for everyone to use now.

@superdav42 superdav42 merged commit a558874 into Multisite-Ultimate:main Apr 17, 2025
6 checks passed
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.

Fix documentation

2 participants