Giters

tarantool / graphql.0

Set of adapters for GraphQL query language to the Tarantool data model

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Create user manual

Totktonada opened this issue · comments

commented

I think the project documentation should have three parts:

  1. API documentation (reference).
    • Where: ldoc is good for that.
    • Problems: now we have parts of a user manual and internal functions descriptions here.
  2. User manual.
    • Where: README, possibly than splitted into separate files.
    • Problems: we almost have no such documentation.
  3. Hacking and internals.
    • Where: separate set of markdown files?
    • Problems: where we have such descriptions they are are in ldoc comments, but they should not be part of the API documentation.
commented

I'm going to archive the repository. I'll proceed as follows:

  • Mark all open pull requests with the archived label and close.
  • Mark all open issues with archived and wontfix labels and close.
  • Archive the repository.

Consider the following projects: