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

Add config options to documentation site #5034

Merged
merged 4 commits into from Jul 21, 2023

Conversation

lc0rp
Copy link
Contributor

@lc0rp lc0rp commented Jul 21, 2023

Background

We get many support requests about things that are configurable, but aren't in the docs. The options.md file that describes the .env options exists but isn't linked from mkdocs.yaml, so it doesn't show up in the online docs at agpt.co/docs

Changes

Added options.md to mkdocs.yaml

Documentation

This is a documentation change

Test Plan

I ran mkdocs locally and confirmed the change.

PR Quality Checklist

  • My pull request is atomic and focuses on a single change.
  • I have thoroughly tested my changes with multiple different prompts.
  • I have considered potential risks and mitigations for my changes.
  • I have documented my changes clearly and comprehensively.
  • I have not snuck in any "extra" small tweaks changes.
  • I have run the following commands against my code to ensure it passes our linters:
    black .
    isort .
    mypy
    autoflake --remove-all-unused-imports --recursive --ignore-init-module-imports --ignore-pass-after-docstring autogpt tests --in-place

@lc0rp lc0rp added this to the v0.4.6 Release milestone Jul 21, 2023
@lc0rp lc0rp added documentation Improvements or additions to documentation and removed size/xs labels Jul 21, 2023
@netlify
Copy link

netlify bot commented Jul 21, 2023

Deploy Preview for auto-gpt-docs canceled.

Name Link
🔨 Latest commit d60a726
🔍 Latest deploy log https://app.netlify.com/sites/auto-gpt-docs/deploys/64bad2cb9d7e83000891d87d

@collijk collijk self-assigned this Jul 21, 2023
@codecov
Copy link

codecov bot commented Jul 21, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (12d1263) 51.07% compared to head (d60a726) 51.07%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #5034   +/-   ##
=======================================
  Coverage   51.07%   51.07%           
=======================================
  Files         119      119           
  Lines        4973     4973           
  Branches      664      664           
=======================================
  Hits         2540     2540           
  Misses       2236     2236           
  Partials      197      197           

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@collijk collijk merged commit 8111770 into Significant-Gravitas:master Jul 21, 2023
16 checks passed
@lc0rp lc0rp deleted the add-options-to-docs branch July 22, 2023 05:57
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 size/xs
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

3 participants