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

Feature Idea: Use MKDocs for documentation #4906

Closed
moose2022 opened this issue Oct 16, 2023 · 0 comments
Closed

Feature Idea: Use MKDocs for documentation #4906

moose2022 opened this issue Oct 16, 2023 · 0 comments
Labels
Enhancement New feature or request Triage

Comments

@moose2022
Copy link

Summary

Utilize MKDocs for Material for a better documentation consumption experience for the users.

How important this is to me and why

Importance: Medium

Right now the docs just link directly to the markdown files in Github, making it difficult to search for specific documentation pieces when using the app.

Use cases:

  1. Implement MKDocs for markdown doc files
  2. Add focalboard header / img

Additional context/similar features

Any examples of good implementations of this capability.

Good example is the MKdocs for Material URL
https://squidfunk.github.io/mkdocs-material/getting-started/

Happy to look at this feature as well.

@moose2022 moose2022 added Enhancement New feature or request Triage labels Oct 16, 2023
@moose2022 moose2022 closed this as not planned Won't fix, can't repro, duplicate, stale Oct 16, 2023
@moose2022 moose2022 reopened this Oct 16, 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 Triage
Projects
None yet
Development

No branches or pull requests

1 participant