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.

Sign up for GitHub

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

Jump to bottom

README and ReadTheDocs feedback #13

Closed
numberoverzero opened this issue Jul 20, 2015 · 1 comment · Fixed by #56
Closed

README and ReadTheDocs feedback #13

numberoverzero opened this issue Jul 20, 2015 · 1 comment · Fixed by #56
Assignees
@numberoverzero
Labels
help wanted question
Milestone
1.0

Comments

@numberoverzero
Copy link
Owner

There needs to be significant iteration on the docs for bloop before a 1.0 release, as many of the features are unlikely to be needed by the first waves of users (such as contextual config swapping, custom object loading, or even custom types).
@numberoverzero numberoverzero self-assigned this Jul 20, 2015
@numberoverzero numberoverzero added this to the 1.0 milestone Jul 20, 2015
@numberoverzero numberoverzero mentioned this issue Jun 21, 2016
Merged
numberoverzero added a commit that referenced this issue Jun 26, 2016
@numberoverzero
Drop docs contents, redo index #13
b6612f8
numberoverzero added a commit that referenced this issue Jun 26, 2016
@numberoverzero
Copy previous Internals docs #13
fc9013c
numberoverzero added a commit that referenced this issue Jun 26, 2016
@numberoverzero
Import docs patterns #13
d25ba98
numberoverzero added a commit that referenced this issue Jun 27, 2016
@numberoverzero
First pass at custom types rewrite #13
ec0a807
numberoverzero added a commit that referenced this issue Jun 28, 2016
@numberoverzero
Document builtin primitive types #13
0faa0c7
numberoverzero added a commit that referenced this issue Jun 28, 2016
@numberoverzero
Document builtin derived types #13
e1459be
numberoverzero added a commit that referenced this issue Jun 28, 2016
@numberoverzero
Document Set, List types #13
0df0f7b
numberoverzero added a commit that referenced this issue Jun 30, 2016
@numberoverzero
Use explicit code-block:: python instead of implicit :: #13
ca604e6
numberoverzero added a commit that referenced this issue Jul 3, 2016
@numberoverzero
Rename some sections #13
01e12ea
numberoverzero added a commit that referenced this issue Jul 3, 2016
@numberoverzero
Adjust docs section headers #13
e4aafce
numberoverzero added a commit that referenced this issue Jul 3, 2016
@numberoverzero
Rewrite docs/internals::Loading #13
bb2c5b6
numberoverzero added a commit that referenced this issue Jul 4, 2016
@numberoverzero
Simplify docs/dev/internal.rst::Loading a lot #13
b556e21
numberoverzero added a commit that referenced this issue Jul 5, 2016
@numberoverzero
docs Tracking/Models #13
36f64aa
numberoverzero added a commit that referenced this issue Jul 7, 2016
@numberoverzero
docs internal Object Marking and Snapshots #13
1eec064
numberoverzero added a commit that referenced this issue Jul 7, 2016
@numberoverzero
docs internal Binding #13
70c879f
numberoverzero added a commit that referenced this issue Jul 8, 2016
@numberoverzero
doc Configuration, draft notes on Atomic Operations #13
e0c3f8e
numberoverzero added a commit that referenced this issue Jul 9, 2016
@numberoverzero
Seriously edit custom types docs, fix subtle bug in Vector types #13
8088ad7
numberoverzero added a commit that referenced this issue Jul 9, 2016
@numberoverzero
docs user/configuration/Client #13
1693a56
numberoverzero added a commit that referenced this issue Jul 9, 2016
@numberoverzero
doc Configuration for Type Engine, drop Binding subsection #13
b45697e
numberoverzero added a commit that referenced this issue Jul 9, 2016
@numberoverzero
Rename keys_only -> keys, docs GSI, LSI #13
25abdd9
numberoverzero added a commit that referenced this issue Jul 10, 2016
@numberoverzero
Index requires projection, doc Projections, outline other docs #13
35f65bb
numberoverzero added a commit that referenced this issue Jul 10, 2016
@numberoverzero
Add outline for remaining docs sections #13
c519588
numberoverzero added a commit that referenced this issue Jul 24, 2016
@numberoverzero
Minor docs cleanup; Internals, Custom Types #13
25f86d9
@numberoverzero numberoverzero mentioned this issue Jul 24, 2016
Closed
numberoverzero added a commit that referenced this issue Aug 6, 2016
@numberoverzero
Start docs Conditions #13
d7e3d7b
numberoverzero added a commit that referenced this issue Aug 6, 2016
@numberoverzero
doc Conditions #13
ecb3012 
still TODO: Conditions."Query, Scan"
numberoverzero added a commit that referenced this issue Aug 7, 2016
@numberoverzero
Last sections for docs/user/conditions! #13
49b83fe
@numberoverzero numberoverzero mentioned this issue Aug 7, 2016
Closed
3 tasks
@numberoverzero
Copy link
Owner Author

numberoverzero commented Aug 7, 2016 •
edited
Loading

Remaining sections:

numberoverzero added a commit that referenced this issue Aug 7, 2016
@numberoverzero
docs Atomic Operations - Limitations #13
704682b
numberoverzero added a commit that referenced this issue Aug 7, 2016
@numberoverzero
Possibly a more drastic rewrite of docs #13
027af9e 
Comparing the previous documentation to other projects (especially
pytest, flask) I think I was trying to cover absolutely every
aspect, in as much detail as possible.  That seemed reasonable at
the time, because I'm familiar with the code.

Stepping back, it seems unapproachable in its sudden depth.  I'm
going to try another approach that walks through different options
as users might discover them.  That also means staying away from
"this is how DynamoDB works" as much as possible.  That can live in
a section in the future if it's something people want.
numberoverzero added a commit that referenced this issue Aug 7, 2016
@numberoverzero
docs placeholder for Types #13
f91e51f
numberoverzero added a commit that referenced this issue Aug 7, 2016
@numberoverzero
doc Indexes, simplify language again #13
917d02d
numberoverzero added a commit that referenced this issue Aug 7, 2016
@numberoverzero
docs Creating Instances #13
40b4892
numberoverzero added a commit that referenced this issue Aug 7, 2016
@numberoverzero
docs Save, Delete #13
bd8e4a4
numberoverzero added a commit that referenced this issue Aug 7, 2016
@numberoverzero
docs type annotations for Defining Models #13
f7e6423
numberoverzero added a commit that referenced this issue Aug 7, 2016
@numberoverzero
docs placeholder for Conditions #13
2f89041
numberoverzero added a commit that referenced this issue Aug 7, 2016
@numberoverzero
docs skeleton for Conditions #13
258c219
numberoverzero added a commit that referenced this issue Aug 7, 2016
@numberoverzero
Slight tweak to seealso style #13
9050f52
numberoverzero added a commit that referenced this issue Aug 7, 2016
@numberoverzero
docs Save/Delete conditions, atomic #13
105b8e8
numberoverzero added a commit that referenced this issue Aug 7, 2016
@numberoverzero
Swap docs to new query/scan syntax #13 #54
62b194c
numberoverzero added a commit that referenced this issue Aug 7, 2016
@numberoverzero
docs Query and Scan examples #13
1a4e4e0
numberoverzero added a commit that referenced this issue Aug 7, 2016
@numberoverzero
docs Query/Scan interface #13
3f6d142
numberoverzero added a commit that referenced this issue Aug 8, 2016
@numberoverzero
docs Query/Scan #13
a1e63aa 
Almost done!  Need to finish Properties in Query/Scan.
numberoverzero added a commit that referenced this issue Aug 8, 2016
@numberoverzero
docs finish Query/Scan. Use ..attribute #13
c107ac3 
Didn't know ..attribute existed, and now it's beautiful.
My hacked-together attempt was failing as the notes expanded past
speciying a default value.

:party-parrot:
numberoverzero added a commit that referenced this issue Aug 8, 2016
@numberoverzero
docs skeleton for Types; clean up sidebar #13
36da810
numberoverzero added a commit that referenced this issue Aug 9, 2016
@numberoverzero
docs 04_types #13
aba1c27 
Still incomplete in types:

* TypedMap
* Map
* Custom Types
numberoverzero added a commit that referenced this issue Aug 10, 2016
@numberoverzero
docs 04_types:Map #13
90b49fe
numberoverzero added a commit that referenced this issue Aug 10, 2016
@numberoverzero
docs completed 04_types.rst #13
e209adc 
Now for 05_conditions!  So close!
numberoverzero added a commit that referenced this issue Aug 11, 2016
@numberoverzero
Document built-in conditions, nitpick other files #13
3f6c473
numberoverzero added a commit that referenced this issue Aug 11, 2016
@numberoverzero
docs Atomic Condition examples #13
754b508
numberoverzero added a commit that referenced this issue Aug 11, 2016
@numberoverzero
docs better User filenames #13
4135b70
@numberoverzero numberoverzero mentioned this issue Aug 11, 2016
Merged
numberoverzero added a commit that referenced this issue Aug 11, 2016
@numberoverzero
Merge pull request #56 from numberoverzero/docs-13-reimagined
13a17c0 
Closes #13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@numberoverzero numberoverzero

Labels
help wanted question
Projects
None yet
Milestone
1.0
Development

Successfully merging a pull request may close this issue.

Docs 13 reimagined numberoverzero/bloop
1 participant
@numberoverzero