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

[WIP] Docs #32

Merged
merged 2 commits into from
Sep 28, 2023
Merged

[WIP] Docs #32

merged 2 commits into from
Sep 28, 2023

Conversation

dwhswenson
Copy link
Member

The goal here is to have enough of a docs page on RTD that someone can tell what we're doing and where we're going, although I don't mind if the docs are quite sparse at this point.

From a diataxis perspective, so far I'm aiming to have a bit of the "theoretical knowledge" hemisphere: let's get the API reference in place as we implement things, and let's fill in enough "Explanation" that someone who stumbles across the project can tell what we're doing, why, and what our goals are.

Everything for "practical steps" can be saved until the code is more complete.

@pep8speaks
Copy link

pep8speaks commented Sep 25, 2023

Hello @dwhswenson! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2023-09-26 00:04:07 UTC

@codecov
Copy link

codecov bot commented Sep 25, 2023

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (c0722a5) 91.44% compared to head (f5862a2) 91.44%.
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #32   +/-   ##
=======================================
  Coverage   91.44%   91.44%           
=======================================
  Files           7        7           
  Lines         526      526           
=======================================
  Hits          481      481           
  Misses         45       45           
Files Coverage Δ
exorcist/taskdb.py 97.48% <ø> (ø)

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@dwhswenson
Copy link
Member Author

I'm going to go ahead and merge this so that we can start building on RTD.

@dwhswenson dwhswenson merged commit 747be2e into main Sep 28, 2023
5 checks passed
@dwhswenson dwhswenson deleted the docs branch September 28, 2023 19:11
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.

2 participants