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

Fix/improve documentation formatting #1575

Merged
merged 2 commits into from
Mar 22, 2024
Merged

Fix/improve documentation formatting #1575

merged 2 commits into from
Mar 22, 2024

Conversation

majabojarska
Copy link
Contributor

@majabojarska majabojarska commented Oct 15, 2023

Description

Fixes markdown formatting/indentation issues to properly render via mkdocs:

  • Enumeration. Several enumerated lists rendered improperly, as multiple "1." entries:
    image
  • Replace sequential enumeration (1. 2. 3. ...) with 1.-based enumeration. The renderer takes care of mapping the correct index to each list element. Generally easier to maintain.
  • Improves readability by using admonitions, e.g.:
    image
  • Improves consistency of monospace formatting for package/image names.

Validation steps

  1. Run mkdocs serve.
  2. Open the live preview.
  3. Inspect the rendered documents relevant to the PR's scope.

  • read the CONTRIBUTING guidelines
  • raised a GitHub issue or discussed it on the projects chat beforehand Not applicable
  • added unit tests Not applicable
  • added integration tests Not applicable
  • updated documentation if needed
  • updated CHANGELOG.md

@majabojarska majabojarska marked this pull request as ready for review October 15, 2023 13:24
@Orhideous
Copy link
Contributor

#1659 may cause potential merge conflict.

@majabojarska
Copy link
Contributor Author

I've refreshed the whole thing, rebased and resolved conflicts.

@kradalby
Copy link
Collaborator

@ohdearaugustin could you have a look?

@ohdearaugustin ohdearaugustin self-assigned this Mar 14, 2024
Copy link
Collaborator

@ohdearaugustin ohdearaugustin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We just need to run prettier again

@ohdearaugustin
Copy link
Collaborator

It seems like that prettier will break most of the changes again.

@ohdearaugustin
Copy link
Collaborator

So I tried now several things that prettier won't destroy the indentation of the code-block in a list, but it seems like nothing works.

Even an ignore block like:

   <!-- prettier-ignore-start -->
   ```shell
   mkdir -p ./headscale/config
   cd ./headscale
  ```
   <!-- prettier-ignore-end -->

My assumption is that mkdocs and prettier use different markdown libraries with different standards for code blocks in lists. I really thinking to add those files just to the ignore list to get it fixed.

Copy link
Collaborator

@ohdearaugustin ohdearaugustin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will merge when #1832 is fixed, then the docu should also be correctly deployed again.

@ohdearaugustin ohdearaugustin merged commit 4d90210 into juanfont:main Mar 22, 2024
98 checks passed
@majabojarska majabojarska deleted the fix_docs_formatting branch March 23, 2024 12:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants