Code Monkey home page Code Monkey logo

documentation's People

Contributors

anakonrad avatar bmark92 avatar companje avatar dinikolop avatar dionenak avatar elena-slavco avatar gerwinbosch avatar huxiaotriply avatar ivadimitrova07 avatar ivan-kovatchev avatar janagrimm avatar kathrinrin avatar kinow avatar laurensrietveld avatar mightymax avatar minatriply avatar mpvharmelen avatar philipperenzen avatar raboof avatar rosalinedehaan avatar rosscurry avatar rubenw avatar simonwtriply avatar tanjaronzhina avatar thomasdegroot18 avatar tiptup10 avatar tom-ch1 avatar wouterbeek avatar ysgorg avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar

documentation's Issues

Switch to ReadTheDocs

Requirements

  • The currently visited page is not highlighted in the left-hand menu.

Screenshot from 2023-07-21 08-19-56

  • The chapters inside a page (h2) are not visible in the left-hand menu. This makes it difficult to find the right version number on the changelog page, or the right function name of a page that documents several functions.

Screenshot from 2023-07-21 08-41-54

Nice to have

  • Red is not a good color for in-line code. It looks too much like something is wrong ("error"), especially when scrolling through a page.

Screenshot from 2023-07-21 08-32-03

  • The vertical space between "Bugfixes:" and the item list of bugfixes is too big. It is currently equivalent to the vertical space between two block elements that are distinct (e.g. two pragraphs). But in an item lists, the introduction and the items belong together. This may not be fixable in ReadTheDocs, because it requires me to write an item list as follows:
Bugfixes:

- Installation on Windows.
- Fixed warnings for a dependency (async-saxophone for XML processing), which did not yet officially support Node.js 18.

Instead of:

Bugfixes:

- Installation on Windows.
- Fixed warnings for a dependency (async-saxophone for XML processing), which did not yet officially support Node.js 18.

So there is not way to distinguish a regular paragraph from a paragraph that introduces an item list.

Screenshot from 2023-07-21 08-34-40

This issue also exists in the real ReadThe Docs (e.g. https://docs.conan.io/2/tutorial/consuming_packages/cross_building_with_conan.html).

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.