tmp/simplex
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

some "about the future" docs stuff

Browse Source
This commit is contained in:
Paul Liverman III 2018-04-25 08:25:54 -07:00
parent 94f75b0c92
commit 366f1a62b5
1 changed files with 63 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
views/docs/v1.moon
View File

@ -59,6 +59,8 @@ class Docs_1 extends Widget
a href: "#errors", "Errors"
li ->
a href: "#rate-limit", "Rate Limiting"
li ->
a href: "#changes", "Changes"
a name: "endpoints"
h2 "Endpoints"
@ -312,3 +314,64 @@ class Docs_1 extends Widget
p "At this time there is no rate limiting. This will be developed when needed, and the API documentation updated to reflect that, with at least 2 months' warning."
a class: ".top", href: "#top", "back to top"
a name: "changes"
h2 "Changes"
p "I intend to keep support for v1 of the API indefinitely. If new features require backwards-incompatible API changes, those will be released under a new version of the API, and v1 will remain accessible for at least 6 months before switching."
p "All new features that do not require modifications to existing API calls will be added to v1 as they are introduced. The next version of the API will only exist if backwards-incompatible changes are introduced."
a class: ".top", href: "#top", "back to top"
a name: "next"
h2 "Coming Next"
p "Until I implement an a tracking system for features/bugs, here is a brief list of features to be added 'soon', and a few known bugs:"
ul ->
li ->
text "Implementing "
code "/random"
text " endpoint."
li ->
code "/edit"
text " endpoint for modifying the "
code "content"
text " of a task. The web interface will also be updated to utilize this."
li ->
code "/search"
text " endpoint. The web interface will also be updated to utilize this."
li "Lists (including the ability to have lists of lists). The API and web interface will receive several updates for this."
li ->
code "/duplicate"
text " endpoint for duplicating a task or list (with optional inclusion of any sub-tasks/sub-lists). The web interface will be updated to utilize this."
li "CLI program for interacting with the API."
li class: "error", ->
text "BUG: IDs are not returned with requests to "
code "/key/new"
text " endpoint."
li "Twitter integration."
li "Data export. (Note: Initially will be a large JSON dump, but you can contact me if you have special needs for data export and I will develop these upon request.)"
p "And this is a list of ideas that may or may not be coming a bit later on, still being thought about:"
ul ->
li "Email integration."
li "Reminders."
li "Recurring tasks."
li "Shared tasks."
li "Customization of web interface. (e.g. select between current interface and a kanban-style board)"
li "Reordering tasks/lists. (This one requires some research on my part of how to implement this efficiently.)"
li "Tagging system (for tasks/lists)."
li "Due dates/times."
li "Webhooks."
li "OAuth2 support."
li "Import from other todo/task management software."
p "Finally, this is a list of a few site-related things I need to get set up:"
ul ->
li "A homepage for non-users showing features / enticing sign-up. Of course. :P"
li "A dynamically updated page showing project status, both in terms of budget (income/expenses) and features/bugs. (This will also allow users to vote for features/bugs to be prioritized.)"
li "A page for accepting payments. At this stage, this is optional and I will be relying purely on people wanting to see this system succeed. In the future, more advanced API features may be behind a subscription model (intended to be $1.50/year)."
a class: ".top", href: "#top", "back to top"