Skip to content
This repository has been archived by the owner on Mar 22, 2024. It is now read-only.

Add a leading file name/path to code blocks consistently #76

Closed
gingerchew opened this issue Nov 8, 2021 · 2 comments
Closed

Add a leading file name/path to code blocks consistently #76

gingerchew opened this issue Nov 8, 2021 · 2 comments
Labels
✏️ documentation Improvements or additions to documentation

Comments

@gingerchew
Copy link
Contributor

What feature were you trying to use?

I was cruising the config documentation.

Where did our docs fail you?

The config documentation had some code blocks that were missing the file name/path that they were related to. Like the vite.config.js blocks didn't have the file name at the top, but the slinkity.config.js ones did.

How can we improve?

The leading file name/path helps me find what I'm looking for, but also helps me not lose track of where I am in the documentation. Having them there in general just helps, regardless of "context change" or only being in one context.

I created a branch that fixed the few I ran into, which I can make a PR for.

@gingerchew gingerchew added the ✏️ documentation Improvements or additions to documentation label Nov 8, 2021
@ajcwebdev
Copy link
Member

Awesome, I always like having these included in code blocks so thanks for cleaning this up for us. Feel free to open up a PR and we can get that merged for you.

@gingerchew
Copy link
Contributor Author

All set #81 😊

@ghost ghost closed this as completed Nov 15, 2021
This issue was closed.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
✏️ documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants