nebari-dev / nebari-docs

📖 Documentation for Nebari
https://www.nebari.dev
BSD 3-Clause "New" or "Revised" License
14 stars 27 forks source link

The documentation style might be outdated on breaking lines #477

Open krassowski opened 1 week ago

krassowski commented 1 week ago

Describe the bug

The documentation style mentions:

https://github.com/nebari-dev/nebari-docs/blob/a2c886af1f6d652804a0423a89eebe840031b564/docs/docs/community/style-guide.md?plain=1#L33

but the linked location does not have a line break link that:

https://github.com/nebari-dev/nebari-docs/blob/a2c886af1f6d652804a0423a89eebe840031b564/docs/docs/how-tos/domain-registry.md?plain=1#L87-L108

Expected behavior

Example is embedded in the style guide instead to avoid link to

How to Reproduce the problem?

Visit https://www.nebari.dev/docs/community/style-guide/

Command output

No response

Versions and dependencies used.

No response

Anything else?

No response