Wikimate icon indicating copy to clipboard operation
Wikimate copied to clipboard

Place PHP documentation tree on GitHub Pages

Open Xymph opened this issue 4 years ago • 2 comments

As proposed here, the documentation tree of the PHP code comments could be placed somewhere publicly, like on GitHub Pages. Here we can hash out the details.

Could this be done on https://xymph.github.io/ or is https://hamstar.github.io/ required because of repo ownership?

Which tool to use, which allows automation with GH Pages, which produces the nicest results?

Plenty to research and experiment...

Xymph avatar Jul 07 '21 10:07 Xymph

(Copying comment originally added to #104)

If we can use GitHub Actions to automatically generate the HTML documentation and add them to a docs/ folder, then serving them from GitHub Pages should be as simple as this:

Screenshot 2021-07-06 at 23 04 52

We would need access to the repository settings, though. Currently only @hamstar has that level of access. I'll email him to see if he's up for it.

waldyrious avatar Jul 07 '21 10:07 waldyrious

Could this be done on xymph.github.io or is hamstar.github.io required because of repo ownership?

We could technically serve the docs from xymph.github.io, but that would be cumbersome because it would require manual syncing of the repositories whenever a change is made to this one, and may be confusing to users due to the latter being marked as a fork of this one. Perhaps we should create an organization for Wikimate? I've emailed @hamstar, let's wait and see what he thinks.

waldyrious avatar Jul 07 '21 10:07 waldyrious