Browse Source

documentation

master
apoc 1 month ago
parent
commit
60c67a311b

+ 4
- 13
README.md View File

@@ -1,21 +1,12 @@
# Exocortex

In this file: documentation, roadmap, issue tracker.
There exists a need to move and/or nuke everything but the source code files so the README might be the most reliable place to put this info in.

# Roadmap & plans

2017:
2018:
2019:
2020:
2021:

There exists a need to move and/or nuke everything but the source code files so the README might be the most reliable place to keep information in.

# Documentation

Code and application structure:
Data structure:
in the docs/ dir.

# Issues
# Issues, roadmap, plans

in the docs/ dir.

+ 37
- 0
docs/issue-tracker.org View File

@@ -0,0 +1,37 @@
* Issues

** Open
*** TODO The client wrapper
**** Issue

The client should have a wrapper for functionality and command aliases.
As noted in the terminology.md file, typing out "{program} problem", "{program} solution" into the CLI will, after a while, train the user to think in terms of problems and solutions.

A solution to this is a sensible and visually simple terminology that does not negatively affect daily habits.
An issue with this, though, is that the tool is intended to be used as a problem-solving knowledgebase and mapper, its data/core is designed around "problems". Adding any terminology other than that complicates things.

**** Solution

The best and simplest thing to resolve this complete issue is to keep the data/core/code terminology based in "problems" and "solutions", and have a wrapper within client programs that turns everything into tree and/or branch-like structures.

**** Notes
***** Versions affected

At the time of opening the issue the latest version of the code is 1.2.1;
Making this change would be a minor, backward compatible change.

*** TODO Moving the server to rails
**** Issue

A basic JSON-response Sinatra HTTP server on ruby handling activerecord won't cut it for much longer.


** Closed
*** DONE Documentation
**** Issue

Missing basic specifications, like the database design and software usage.
This usually goes into a Wiki but the project is still in the prototype stage and the repo itself is likely to move a lot.
**** Solution

Keep a ./docs/ dir within the project repository and write in some basic information there.

+ 5
- 5
docs/roadmap.md View File

@@ -1,7 +1,7 @@
Добро пожаловать в Вики.
Roadmap:

-
-
-

- 2017: idea, prototype
- 2018: prototype, discussion
- 2019: prototype, testing
- 2020: personal daily use
- 2021: ?

+ 0
- 0
docs/specifications/database.design.yml View File


+ 0
- 0
docs/specifications/usage.yml View File


+ 0
- 0
docs/terminology.md View File


Loading…
Cancel
Save