PurpleTurtleCreative / completionist

Asana integration plugin for WordPress.
https://purpleturtlecreative.com/completionist/
GNU General Public License v3.0
1 stars 0 forks source link

Documentation should be included and served from this source code repository #213

Closed MichelleBlanchette closed 4 months ago

MichelleBlanchette commented 4 months ago

Documentation is currently served from GitHub Pages in https://github.com/PurpleTurtleCreative/purpleturtlecreative.github.io

This means documentation updates are deployed separately from code releases which is very awkward. Also, users don't receive the "manual" with the code package. If the docs are included, then users have/own everything they could need. It also makes it very clear which docs pertain to which source code packages (as we expand our software offerings).

MichelleBlanchette commented 4 months ago

This GitHub Pages documentation seems to suggest the project-specific URL will just work: https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages#using-a-custom-domain-across-multiple-repositories

That'd be awesome! That architecture is so much better, to have the docs included within and hosted/built from the actual source code project repo. Then I can actually update the documentation alongside the code changes I'm actually making that need to be documented. That's the whole goal here!

MichelleBlanchette commented 4 months ago

Well, that was especially easy! This is so much better now, WOW!!! VERY cool organization and workflow. LOVE IT!!! 😍

https://docs.purpleturtlecreative.com/completionist/