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

Basic docs with tutorial #96

Merged
merged 12 commits into from
Jun 19, 2024
Merged

Basic docs with tutorial #96

merged 12 commits into from
Jun 19, 2024

Conversation

fjsj
Copy link
Member

@fjsj fjsj commented Jun 18, 2024

Partial work for #81

If you feel anything add to that issue.

To see the docs, run poetry install, then poetry shell, then mkdocs serve in project root.

@@ -17,6 +17,7 @@
can_delete_message,
can_delete_thread,
can_run_assistant,
can_view_thread,
Copy link
Member Author

@fjsj fjsj Jun 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This permission was on examples, but not being used. Added now.

@@ -157,7 +157,6 @@

# django-ai-assistant

OPENAI_API_KEY = os.getenv("OPENAI_API_KEY")
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unnecessary, since we use python-dotenv.

docs/get-started.md Outdated Show resolved Hide resolved
docs/tutorial.md Outdated Show resolved Hide resolved
docs/tutorial.md Outdated Show resolved Hide resolved
docs/tutorial.md Outdated Show resolved Hide resolved
mkdocs.yml Outdated Show resolved Hide resolved
Copy link
Contributor

@amandasavluchinske amandasavluchinske left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just left some suggested copy changes, but LGTM.

docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/index.md Outdated Show resolved Hide resolved
docs/tutorial.md Outdated Show resolved Hide resolved
docs/tutorial.md Outdated Show resolved Hide resolved
fjsj and others added 9 commits June 19, 2024 10:02
Co-authored-by: Pamella Bezerra <pamella@vinta.com.br>
Co-authored-by: Pamella Bezerra <pamella@vinta.com.br>
Co-authored-by: Amanda Savluchinske <amandasavluchinske@gmail.com>
Co-authored-by: Amanda Savluchinske <amandasavluchinske@gmail.com>
Co-authored-by: Amanda Savluchinske <amandasavluchinske@gmail.com>
Co-authored-by: Amanda Savluchinske <amandasavluchinske@gmail.com>
Co-authored-by: Amanda Savluchinske <amandasavluchinske@gmail.com>
@fjsj fjsj requested a review from pamella June 19, 2024 13:09
Copy link
Collaborator

@pamella pamella left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

There's just a poetry conflict due to the last merge to main.

@pamella pamella merged commit 84aabec into main Jun 19, 2024
6 checks passed
@pamella pamella deleted the feat/docs branch June 19, 2024 14:03
@pamella
Copy link
Collaborator

pamella commented Jun 19, 2024

@fjsj I merged this PR so I can update the docs on #98

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants