mirror of
https://github.com/qodo-ai/pr-agent.git
synced 2025-12-12 02:45:18 +00:00
Update docs readme
This commit is contained in:
parent
61388f6d28
commit
09f76f45ef
1 changed files with 1 additions and 16 deletions
|
|
@ -1,16 +1 @@
|
|||
# To install:
|
||||
pip install mkdocs
|
||||
pip install mkdocs-material
|
||||
pip install mkdocs-material-extensions
|
||||
pip install "mkdocs-material[imaging]"
|
||||
|
||||
# docs
|
||||
To run localy: `mkdocs serve`
|
||||
|
||||
To expand and customize the theme: [Material MKDocs](https://squidfunk.github.io/mkdocs-material/)
|
||||
|
||||
The deployment is managed on the gh-pages branches.
|
||||
After each merge to main the deplloyment will be taken care of by GH action automatically and the new version will be available at: [Docs](https://codium-ai.github.io/docs/)
|
||||
|
||||
Github action is located in `.github/workflows/ci.yml` file.
|
||||
|
||||
# [Visit Our Docs Portal](https://pr-agent-docs.codium.ai/)
|
||||
|
|
|
|||
Loading…
Reference in a new issue