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

Markdown Text Snippets Imports #418

Open
bgodlin opened this issue Sep 15, 2023 · 0 comments
Open

Markdown Text Snippets Imports #418

bgodlin opened this issue Sep 15, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@bgodlin
Copy link
Contributor

bgodlin commented Sep 15, 2023

Objective

Ensure compliance with the DRY (Don't Repeat Yourself) principle in our documentation. Currently, we have identified instances of redundancy in our documentation, as evidenced, for instance, by the following two lines:

Description

After conducting initial research, I couldn't find an existing solution for Vuepress documentation (https://v2.vuepress.vuejs.org/guide/). However, for different platforms like Vitepress (https://vitepress.dev/guide/markdown#markdown-file-inclusion), such functionality is possible. Therefore, an additional research effort may be required to find or develop a suitable solution for Vuepress.

Benefits

Implementing this feature will help us keep our documentation concise, consistent, and easier to maintain.

@bgodlin bgodlin added the enhancement New feature or request label Sep 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant