Skip to content

Commit

Permalink
Merge pull request #845 from Codium-ai/change-docs-readme
Browse files Browse the repository at this point in the history
Update docs readme
  • Loading branch information
mrT23 authored Apr 8, 2024
2 parents 61388f6 + 09f76f4 commit 236d7c4
Showing 1 changed file with 1 addition and 16 deletions.
17 changes: 1 addition & 16 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -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/)

0 comments on commit 236d7c4

Please sign in to comment.