Create documentation site #3
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
caendesilva
commented
Nov 30, 2023
| id-token: write | ||
| environment: | ||
| name: github-pages | ||
| url: https://friendsofphp.github.io/number |
There was a problem hiding this comment.
What URL should we deploy to?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Abstract
Adds a script to generate documentation (that's always up to date) based on the readme and the code through reflection and source analysis. This script is then called in the added workflow which then builds the site using HydePHP and deploys it to GitHub Pages through the HydePHP Action
Preview
There is a live preview at https://git.desilva.se/temp/number-docs-preview, please try it out!
Code review
Before merging, I'd love to get some feedback from the team. (Also present as code review comments)