Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Place PHP documentation tree on GitHub Pages #110

Open
Xymph opened this issue Jul 7, 2021 · 2 comments
Open

Place PHP documentation tree on GitHub Pages #110

Xymph opened this issue Jul 7, 2021 · 2 comments

Comments

@Xymph
Copy link
Collaborator

Xymph commented Jul 7, 2021

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 Xymph mentioned this issue Jul 7, 2021
@waldyrious
Copy link
Collaborator

waldyrious commented Jul 7, 2021

(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
Copy link
Collaborator

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.

@Xymph Xymph changed the title Place PHP documentation tree on GitHub Pages? Place PHP documentation tree on GitHub Pages Aug 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants