Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

feat(docs): add mkdocs #153

Merged
merged 23 commits into from
Nov 22, 2023
Merged

feat(docs): add mkdocs #153

merged 23 commits into from
Nov 22, 2023

Conversation

ajndkr
Copy link
Owner

@ajndkr ajndkr commented Nov 22, 2023

Description

This PR replaces the old sphinx documentation with mkdocs (theme: mkdocs-material)

Changelog:

  • βž• added new dependencies
  • πŸ”§ added mkdocs configuration files
  • πŸ“ added new documentation (more to come in future PRs)
  • πŸ› minor bugfixes

@ajndkr ajndkr self-assigned this Nov 22, 2023
@ajndkr ajndkr added documentation Improvements or additions to documentation dependencies labels Nov 22, 2023
@ajndkr ajndkr merged commit 8fdf2be into release/v0.8 Nov 22, 2023
2 checks passed
@ajndkr ajndkr deleted the feat/add-mkdocs branch November 22, 2023 19:24
ajndkr added a commit that referenced this pull request Nov 24, 2023
* βž• add docs dependencies

* 🍱 add doc assets

* πŸ’„ add custom css

* πŸ”§ add mkdocs.yml

* 🍱 update assets

* πŸ“ update README

* πŸ”§ update mkdocs.yml

* πŸ“ add home page

* 🍱 add doc assets

* πŸ“ remove documentation badge

* πŸ‘· add workflow to publish docs

* πŸ’„ update primary color

* 🚧 test deployment

* πŸ”§ add CNAME

* πŸ‘· update GA workflow

* πŸ“ update README

* βž• add docs dependency

* πŸ”§ update mkdocs.yml

* πŸ’„ update css

* πŸ“ update home page

* πŸ“ add getting started page

* πŸ› fix callback handler bug

* πŸ“ update code
ajndkr added a commit that referenced this pull request Nov 24, 2023
* βž• add docs dependencies

* 🍱 add doc assets

* πŸ’„ add custom css

* πŸ”§ add mkdocs.yml

* 🍱 update assets

* πŸ“ update README

* πŸ”§ update mkdocs.yml

* πŸ“ add home page

* 🍱 add doc assets

* πŸ“ remove documentation badge

* πŸ‘· add workflow to publish docs

* πŸ’„ update primary color

* 🚧 test deployment

* πŸ”§ add CNAME

* πŸ‘· update GA workflow

* πŸ“ update README

* βž• add docs dependency

* πŸ”§ update mkdocs.yml

* πŸ’„ update css

* πŸ“ update home page

* πŸ“ add getting started page

* πŸ› fix callback handler bug

* πŸ“ update code
@ajndkr ajndkr added this to the v0.8 milestone Nov 24, 2023
ajndkr added a commit that referenced this pull request Nov 28, 2023
* βž• add docs dependencies

* 🍱 add doc assets

* πŸ’„ add custom css

* πŸ”§ add mkdocs.yml

* 🍱 update assets

* πŸ“ update README

* πŸ”§ update mkdocs.yml

* πŸ“ add home page

* 🍱 add doc assets

* πŸ“ remove documentation badge

* πŸ‘· add workflow to publish docs

* πŸ’„ update primary color

* 🚧 test deployment

* πŸ”§ add CNAME

* πŸ‘· update GA workflow

* πŸ“ update README

* βž• add docs dependency

* πŸ”§ update mkdocs.yml

* πŸ’„ update css

* πŸ“ update home page

* πŸ“ add getting started page

* πŸ› fix callback handler bug

* πŸ“ update code
@ajndkr ajndkr mentioned this pull request Nov 28, 2023
ajndkr added a commit that referenced this pull request Nov 29, 2023
* feat(core): introduce Adapters API (#151)

* feat(docs): add mkdocs (#153)

* feat(adapter): add OpenAI adapter (#155)

* chore(unit): improve code coverage (#157)

* feat: update documentation (#158)

* feat(demo): add examples (#159)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant