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

Documentation System Enhancements #69

Open
ChrisHinchey opened this issue Feb 9, 2023 · 0 comments
Open

Documentation System Enhancements #69

ChrisHinchey opened this issue Feb 9, 2023 · 0 comments
Labels
enhancement New feature or request page: documentation Improvements or additions to documentation
Milestone

Comments

@ChrisHinchey
Copy link
Contributor

ChrisHinchey commented Feb 9, 2023

  • As documentation grows, think about displaying list of all the documentation at the documentation index page. This will also ensure that the documentation system follows the DRY principle. The current implementation has an index page which fetches the first page, repeating most of the code from the dynamic page ([section].vue).
  • (Thought) Have a documentation grouping Strapi collection type separate from the current documentation collection type in Strapi. It will group like docs (i.e., documentation) together.
    • For example, the index page for /docs will be a grid of documentation grouping (e.g., Heimdall, Vulcan, etc.) where the user can choose which one to browse to. This will solve the non DRY code in the first bullet point and organize documentation section.
    • Expand the documentation GraphQL call so that a limit is defined similar to the limit added to the blog post GraphQL query. By default it will only grab 10 documentation if it isn't defined.
@ChrisHinchey ChrisHinchey added this to the V2 milestone Feb 9, 2023
@github-project-automation github-project-automation bot moved this to 🏗 In progress in SAF Site Feb 9, 2023
@ChrisHinchey ChrisHinchey moved this from 🏗 In progress to 📋 Backlog in SAF Site Feb 9, 2023
@ChrisHinchey ChrisHinchey added page: documentation Improvements or additions to documentation enhancement New feature or request labels Feb 13, 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 page: documentation Improvements or additions to documentation
Projects
Status: 📋 Backlog
Development

No branches or pull requests

1 participant