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

Docs website: update for release of PHPCSUtils 1.0.0-alpha4 #396

Merged
merged 6 commits into from
Oct 25, 2022

Conversation

jrfnl
Copy link
Member

@jrfnl jrfnl commented Oct 25, 2022

Doc website: update the phpDocumentor configuration

... after recent fixes in phpDocumentor3.

Doc website: regen of PHPCSUtils 1.0.0-alpha3 documentation

... using the latest released version of phpDocumentor (3.3.1) so the diff for the actual regen of version 1.0.0-alpha4 will only show the differences in content, not document structure.

Doc website: update documentation for PHPCSUtils 1.0.0-alpha4

The docs have been regenerated using phpDocumentor 3.3.1 with --visibility=public,protected.

GH Pages: minor template tweaks

  • Always display link to the project on GH.
    The site.github.is_project_page key does not seem to be reliable.
  • Display the version number of the last release, if available.
  • Always display the "Maintained by" link.
  • Remove duplicate header close tag.

GH Pages: minor tweaks to the configuration file

Includes adding a commonmark configuration to prevent Commonmark blindly stripping all HTML.

Docs website: sync readme changes into docs index.md

... after recent fixes in phpDocumentor3.
... using the latest released version of phpDocumentor (`3.3.1`) so the diff for the actual regen of version 1.0.0-alpha4 will only show the differences in content, not document structure.
The docs have been regenerated using phpDocumentor 3.3.1 with `--visibility=public,protected`.
* Always display link to the project on GH.
    The `site.github.is_project_page` key does not seem to be reliable.
* Display the version number of the last release, if available.
* Always display the "Maintained by" link.
* Remove duplicate `header` close tag.
Includes adding a `commonmark` configuration to prevent Commonmark blindly stripping _all_ HTML.
@jrfnl jrfnl added this to the 1.0.0-alpha4 milestone Oct 25, 2022
@jrfnl jrfnl enabled auto-merge October 25, 2022 12:57
@jrfnl jrfnl merged commit 21c03f1 into develop Oct 25, 2022
@jrfnl jrfnl deleted the docs-website/update-configuration-and-content branch October 25, 2022 13:04
@jrfnl jrfnl mentioned this pull request Oct 25, 2022
16 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant