nestdotland/docs

📖 The documentation for nest.land

docs's Issues

Badges are sized differently than standard shields

🐛 Bug Report

The nest large badge (for-the-badge) are differently sized than the standard shields used by shields.io

To Reproduce

Round example (flat style)

Block example (flat-square style)

Large example (for-the-badge style)

Expected behavior

All the groups should be in the same style.

Actual Behavior

The large badge is different from shields.io size and style

Unexpected Layout on Narrow Desktop / iPad

Is your feature request related to a problem? If so, please describe.

When the window size changed to between $MQNarrow and $MQMobile (probably 959px and 719px in my observation), the width of the sidebar enlarged to 75vw unexpectedly. It caused the main content of the documentation hard to read.

Describe the solution you'd like

In /docs/.vuepress/theme/styles/mobile.styl:

...
// line 6
// narrow desktop / iPad
@media (max-width: $MQNarrow)
  .sidebar
    font-size 15px
-    width $mobileSidebarWidth

-  .navbar
-    .sidebar-bg-mask
-      width $mobileSidebarWidth

-  .page
-    padding-left $mobileSidebarWidth

  a.header-anchor
    margin-left -.4em

// wide mobile
@media (max-width: $MQMobile)
  .sidebar
+    width $mobileSidebarWidth
...

Remove the unexpected width of the sidebar and padding of the main content on narrow desktop / iPad. Keep the expected 75vw width of the sidebar on wide mobile.

Describe alternatives you've considered

N/A

Additional context

Before changing mobile.styl:

After changing mobile.styl:

[FEATURE] Adding "edit this page" links

In various documentation sites, they include a link to the source of the docs somewhere to encourage users to submit PRs if they deem necessary. I think that something like this would prove to be beneficial on our docs as well.

For example, the Arweave documentation has this: