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

[documentation]: Readthedocs Improvements #234

Closed
1 task done
ReinhardKeil opened this issue Dec 15, 2024 · 0 comments
Closed
1 task done

[documentation]: Readthedocs Improvements #234

ReinhardKeil opened this issue Dec 15, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@ReinhardKeil
Copy link
Collaborator

ReinhardKeil commented Dec 15, 2024

Is there an existing issue for this?

  • I have searched the existing issues

This is a list of little things with the Mkdocs version https://open-cmsis-pack.github.io/cmsis-toolbox/

✔️ Wrap Table Text

Current Behavior

In the new documentation, table text does not longer wrap.
See: https://open-cmsis-pack.github.io/cmsis-toolbox/#revision-history

Expected Behavior

Explore if this mkdocs/mkdocs#3035 can be used to make it appear better.

✔️ Edit on GitHub

The button Edit on GitHub is great to let users fix little things. However, it does not go to the correct directory. Can this be addressed.

✔️ Max Width

Having a width limit improves readability. However, I suggest to increase the setting slightly so that examples like here don't require a scroll bar.
https://open-cmsis-pack.github.io/cmsis-toolbox/YML-Input-Format/#pack-name-conventions

Potential solution: Add this to extra *.css. (see also mkdocs/mkdocs#3598)

.wy-nav-content {
    max-width: 900px;
}

❌ Copy Code Button

Enable the copy code button (https://squidfunk.github.io/mkdocs-material/reference/code-blocks/)

This will be not fixed, as cut and paste is working fine.

✔️ Bullet Point List Spacing

The integrated GitHub formatter offers different bullet point spacing. An empty line in a bullet point list increases spacing.
See the difference on this pages:
https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/index.md
https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/overview.md

Fix is to add this to extra *.css.

.rst-content .section ul li p:last-child {
    padding: 0px 0px 8px 0px;
}

A: Need to review Python-Markdown/markdown#1497

✔️ Bullet Point Indenting

Mkdocs does not consider the bullet point indents. See the difference on this page:
https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/overview.md
https://open-cmsis-pack.github.io/cmsis-toolbox/overview/

To fix this use 4 intends. Note that markdownlint should be configured for this. In VS Code add to settings.json

    "markdownlint.config": {
          "ul-indent": {
            "indent": 4
          }
    },
@ReinhardKeil ReinhardKeil added the enhancement New feature or request label Dec 15, 2024
@ReinhardKeil ReinhardKeil changed the title [UX Enhancement]: Readthedocs table wrap text [UX Enhancement]: Readthedocs Improvements Dec 15, 2024
@jkrech jkrech moved this to Todo in CMSIS-Toolbox 2.8.0 Dec 17, 2024
@ReinhardKeil ReinhardKeil moved this from Todo to Done in CMSIS-Toolbox 2.8.0 Jan 14, 2025
@ReinhardKeil ReinhardKeil closed this as completed by moving to Done in CMSIS-Toolbox 2.8.0 Jan 14, 2025
@jkrech jkrech changed the title [UX Enhancement]: Readthedocs Improvements [documentation]: Readthedocs Improvements Feb 11, 2025
@jkrech jkrech added the documentation Improvements or additions to documentation label Feb 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
Status: Done
Development

No branches or pull requests

3 participants