xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-08 14:50:40 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #845 from Codium-ai/change-docs-readme

Browse Source 
Update docs readme
This commit is contained in:
Tal
2024-04-08 09:06:23 +03:00
committed by GitHub
parent 61388f6d28 09f76f45ef
commit 236d7c44e2
1 changed files with 1 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/README.md
View File

@ -1,16 +1 @@
# To install: # [Visit Our Docs Portal](https://pr-agent-docs.codium.ai/)
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.