Skip to content

Improve documentation design #9

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.

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

Closed
7 of 8 tasks
lenkis opened this issue Jul 14, 2016 · 2 comments
Closed
7 of 8 tasks

Improve documentation design #9

lenkis opened this issue Jul 14, 2016 · 2 comments
Assignees
Labels
design [nature] Design issue

Comments

@lenkis
Copy link
Contributor

lenkis commented Jul 14, 2016

Suggestions:

  • Make TOC hide/show on demand + let the main text occupy more screen width
  • Include all subsections in TOC (for convenience, maybe add expandable nested sections to the TOC, like in tarantool-c doc)
  • Increase font size in func descriptions, both in text and auto-generated labels like "Parameters" (make it = general body text) - e.g. see the bug in https://tarantool.org/doc/reference_lua/msgpack.html?highlight=msgpack#module-msgpack
  • Make vertical paddings before some paragraphs narrower:
    • before the first item in a bullet list
    • before parts of a func description (parameters, rtype, etc)
  • Multiple functions definitions with one name - normal display
  • Refactor .. varfunc:: -> italic in {}
  • Center images in App D. Vinyl
  • Cookbook - Every example must have links. Break it into chapters.
@lenkis
Copy link
Contributor Author

lenkis commented Aug 9, 2016

comments to fix-markup branch:

  1. can we decrease the lower padding after intro paragraphs before bullet lists? see green on the screenshot:

screen shot 2016-08-09 at 18 25 37

  1. text in function descriptions is now smaller than body text, can we increase it to match body text? here's a screenshot to illustrate my concern:
    screen shot 2016-08-09 at 18 26 41

@mejedi mejedi added the design [nature] Design issue label Oct 7, 2016
This was referenced Oct 7, 2016
@bigbes
Copy link
Contributor

bigbes commented Dec 14, 2016

Probably done. ("Make TOC hide/show on demand + let the main text occupy more screen width" was moved to its own ticket gh-138)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
design [nature] Design issue
Projects
None yet
Development

No branches or pull requests

3 participants