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

Various docs updates #165

Merged
merged 5 commits into from
Apr 25, 2024
Merged

Various docs updates #165

merged 5 commits into from
Apr 25, 2024

Conversation

elijahbenizzy
Copy link
Contributor

Changes

Makes Burr getting started more topical + provides basic summaries

Checklist

  • PR has an informative and human-readable title (this will be pulled into the release notes)
  • Changes are limited to a single goal (no scope creep)
  • Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
  • Any change in functionality is tested
  • New functions are documented (with a description, list of inputs, and expected output)
  • Placeholder code is flagged / future TODOs are captured in comments
  • Project documentation has been updated if adding/changing functionality.

@elijahbenizzy elijahbenizzy requested a review from skrawcz April 25, 2024 16:02
@elijahbenizzy elijahbenizzy merged commit 62c9159 into main Apr 25, 2024
7 checks passed
@elijahbenizzy elijahbenizzy deleted the docs-fix branch April 25, 2024 18:23
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.

1 participant