mattermost-community / focalboard

Focalboard is an open source, self-hosted alternative to Trello, Notion, and Asana.
https://www.focalboard.com
Other
22.05k stars 1.98k forks source link

Feature Idea: Use MKDocs for documentation #4906

Closed moose2022 closed 1 year ago

moose2022 commented 1 year ago

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.