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

Adding FAQ to the documentation site #538

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

kallewesterling
Copy link
Contributor

Summary

Adds in a FAQ document with all the questions that we normally get during our workshops/community calls and from folks of varying degrees of technical ability.

Fixes #184.

Describe your changes

No code changes. Only edits to the docs directory.

Checklist before assigning a reviewer (update as needed)

  • Self-review code
  • Ensure submission passes current tests
  • Add tests
  • Update relevant docs
  • Update changelog

Reviewer checklist

Please add anything you want reviewers to specifically focus/comment on.

  • Everything looks ok?

@kallewesterling kallewesterling changed the title Initial FAQ document linked into getting-started Adding FAQ to the documentation site Dec 10, 2024
Copy link

codecov bot commented Dec 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Flag Coverage Δ
unittests 79.98% <ø> (+2.31%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

see 9 files with indirect coverage changes

@kallewesterling
Copy link
Contributor Author

@kmcdono2 This could do with a bit of your eyes on it!

Copy link
Collaborator

@kmcdono2 kmcdono2 left a comment

Choose a reason for hiding this comment

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

I've made some updates.

docs/source/getting-started/faq.rst Outdated Show resolved Hide resolved
docs/source/getting-started/faq.rst Outdated Show resolved Hide resolved
docs/source/getting-started/faq.rst Outdated Show resolved Hide resolved
docs/source/getting-started/faq.rst Outdated Show resolved Hide resolved
@kallewesterling
Copy link
Contributor Author

Great, thanks @kmcdono2

@kallewesterling
Copy link
Contributor Author

OK, edits have been implemented tonight @kmcdono2

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.

Add a FAQ in the docs
2 participants