Skip to content
New issue

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

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

Already on GitHub? # to your account

feat: add documentation commands to Makefile #431

Merged
merged 2 commits into from
Dec 10, 2024
Merged

Conversation

calvinhp
Copy link
Member

  • Added new commands 'docs' to build documentation and 'serve-docs' to serve documentation
  • Supports mkdocs with mermaid and emojis
  • Cleaned up .PHONY declarations for ci, check-lint-and-formatting, and secure

- Added new commands 'docs' to build documentation and 'serve-docs' to serve documentation
- Cleaned up .PHONY declarations for ci, check-lint-and-formatting, and secure
Copy link
Contributor

@rochecompaan rochecompaan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Using uvx to build and run local processes breaks our pattern of building and running it inside containers. Can we follow a similar approach to make compile for mkdocs until we rethink and refactor our local toolchain?

…ion commands

- Added a target `ensure-uv` to check for the installation of UV and install it if missing.
- Updated `docs` and `serve-docs` targets to depend on `ensure-uv`.
- Enhanced documentation commands to use consistent casing.
- Modified `.gitignore` to include `.aider*` files.
@calvinhp calvinhp merged commit 824e1d6 into main Dec 10, 2024
3 checks passed
@calvinhp calvinhp deleted the calvinhp/add-mkdocs branch December 10, 2024 12:14
github-actions bot pushed a commit that referenced this pull request Dec 10, 2024
## [1.20.0](v1.19.1...v1.20.0) (2024-12-10)

### Features

* add documentation commands to Makefile ([#431](#431)) ([824e1d6](824e1d6))

### Documentation

* add qa markdown page ([#427](#427)) ([0e8c0fe](0e8c0fe))
* reorganize next steps and dependencies sections + fix typos ([#426](#426)) ([a7e8af6](a7e8af6))
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants