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: setup project documentation #36

Closed
2 tasks
ajndkr opened this issue May 11, 2023 · 2 comments · Fixed by #48
Closed
2 tasks

feat: setup project documentation #36

ajndkr opened this issue May 11, 2023 · 2 comments · Fixed by #48
Assignees
Labels
documentation Improvements or additions to documentation feature New feature or request

Comments

@ajndkr
Copy link
Owner

ajndkr commented May 11, 2023

As the project grows, there is a strong need for a docs page for new (and existing) users to find information which might be too verbose to add to the repo README.

For the first version, we can add:

  • getting started
  • api reference
  • tutorial 1: deploy basic llm chain
  • tutorial 2: deploy chains with vector store / retriever
  • tutorial 3: deploy custom chains

Acceptance Criteria

@ajndkr ajndkr added documentation Improvements or additions to documentation feature New feature or request labels May 11, 2023
@ajndkr ajndkr self-assigned this May 11, 2023
@ajndkr
Copy link
Owner Author

ajndkr commented May 11, 2023

@rogalvil any recommendations towards this?

@rogalvil
Copy link
Contributor

@ajndkr Honestly, I don't have any recommendations. I don't have much experience with documentation.

@ajndkr ajndkr linked a pull request May 18, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation feature New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants