Skip to content
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

docs: Document snapshots, add "New in version x", def.-list styling, better config options documentation #862

Merged
merged 11 commits into from
May 5, 2022

Conversation

ix5
Copy link
Member

@ix5 ix5 commented May 5, 2022

docs: testing-client: Document Jest snapshots

docs/contrib: doc: Add versionadded note, more links

docs/contrib: Format 'complexity' section as hlist

Will be evenly distributed into two columns, easing readability and taking up less space

docs: css: Use deeper blue for links

docs: css: Style versionchanged, defn.-lists

Style versionchanged, versionadded, deprecated` directives to display e.g. "Changed in 0.12.6" with a slight yellow background.

Style definition lists to that titles stick out more.

docs: client-conf: Use default dl, annotate added/deprecated

docs: server-conf: Add defaults, clarify more

Some sections were a bit out of date or did not convey the intent to users properly.

Also correct styling (many markdown-style single backticks where reST needs double ones) and add some more structural elements.

Minor nitpicking:

  • isso: isso.cfg: Add link for misaka exts
  • docs: contrib: More links, clarification
  • docs: toc: Remove superfluous file ext
  • docs: css: Do not vertically center hlist items

ix5 added 11 commits May 5, 2022 15:02
Will be evenly distributed into two columns, easing
readability and taking up less space
Style `versionchanged`, `versionadded`, deprecated`
directives to display e.g. "Changed in 0.12.6" with a slight
yellow background.

Style definition lists to that titles stick out more.
Some sections were a bit out of date or did not convey the
intent to users properly.

Also correct styling (many markdown-style single backticks
where reST needs double ones) and add some more structural
elements.
@ix5 ix5 added docs Documentation of the project improvement Not a new feature, but makes Isso more pleasant to use labels May 5, 2022
@ix5 ix5 added this to the 0.13 milestone May 5, 2022
@ix5
Copy link
Member Author

ix5 commented May 5, 2022

Visual comparison

Before:
Screenshot from 2022-05-05 18-49-12


After:
Screenshot from 2022-05-05 18-48-49

@ix5 ix5 merged commit ede2fff into isso-comments:master May 5, 2022
@ix5 ix5 deleted the docs-snapshots-style-configs branch May 5, 2022 16:57
@ix5 ix5 mentioned this pull request May 25, 2022
38 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation of the project improvement Not a new feature, but makes Isso more pleasant to use
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant