Skip to content

Commit

Permalink
Document docs workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
spawnia committed Feb 15, 2024
1 parent 4c80c96 commit 45ccc40
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
5 changes: 4 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ For smaller contributions just use this workflow:

- Fork the project.
- Add your features and or bug fixes.
- Add tests. Tests are important for us.
- Add tests to ensure your changes work and will continue working.
- Check your changes using `composer check`.
- Add an entry to the [Changelog's Unreleased section](CHANGELOG.md#unreleased).
- Send a pull request.
Expand Down Expand Up @@ -134,6 +134,9 @@ composer bench

We document this library by rendering the Markdown files in [docs](docs) with [MkDocs](https://www.mkdocs.org).

> You may propose changes to the docs via merge requests against the `master` branch.
> Do not edit the generated HTML files in the `gh-pages` branch directly, they are automatically generated.
Generate the class reference docs:

```sh
Expand Down
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ it: fix stan test docs ## Run the commonly used targets
help: ## Displays this list of targets with descriptions
@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(firstword $(MAKEFILE_LIST)) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[32m%-30s\033[0m %s\n", $$1, $$2}'

.PHONY: setup
setup: vendor ## Set up the project

.PHONY: fix
fix: rector php-cs-fixer ## Automatic code fixes

Expand Down

0 comments on commit 45ccc40

Please sign in to comment.