Re-work docs to better highlight the problems sphobjinv solves & how it solves them #270
Labels
area: docs 📄
issue: planned ⌚
Assigned to a specific version's milestone
type: enhancement ✨
Something to add
Milestone
Per Discord conversation with @CAM-Gerlach, docs currently are unclear and poorly organized.
This is correct. Indeed, they grew organically from the original v1.0 docs, which were only documenting the
convert
CLI, to include the new API and thesuggest
feature.Time to re-work them, with intentionality. His suggestions, heavily excerpted/summarized:
High level summarize these and point to other places in docs for more info:
Front page:
Possible outline for revised front page:
The text was updated successfully, but these errors were encountered: