nushell / nushell/nushell.github.io
Determine how to handle Vuepress code snippets in docs
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 258
- Forks
- 561
- Avg merge
- 3h 20m
- Merged PRs (30d)
- 15
Description
I just noticed that the Book uses some Vuepress code snippets in places (but not everywhere). There are some advantages and disadvantages to these:
Advantages:
- (Minor) Can be reused if needed
- (Nice) Indention is much easier if the code-block is nested under a list item
Disadvantages:
- (Major) All of the existing snippets are
.shfiles. These need to be updated to.nufiles in order to obtain proper syntax highlighting, of course. - (Major) Renaming or moving a snippet requires updates to all language translations, otherwise we are left with broken links.
- When a code snippet is updated, it is propagated across all language translations. This sounds nice, but that may not be desirable if the text around it needs to be updated as well, which will likely be the case.
- Probably won't be portable if we change backends in the future
When I first saw these, I liked the concept, but after dealing with the ramifications, it seems like they might be more problematic than helpful.
At the least, all of them have to be reworked to get syntax highlighting. Should this just be a single "eliminate Vuepress snippets" enhancement?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the Book's existing Vuepress code snippets, their .sh files, and corresponding language translations. Compare the maintenance and syntax-highlighting implications described here; done means reaching and documenting a clear decision on whether to retain or eliminate the snippets and what must be updated.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- shell
- Domain
- documentation, localization
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100