docs: rewrite README from adoc to md with improvements#442
docs: rewrite README from adoc to md with improvements#442codayon wants to merge 3 commits intoOpenBangla:developfrom
Conversation
updated the README to enhance clarity and correctness.
|
@mominul, I haven't included the logo or icon yet. I think a banner would look better because the current header takes up the same height as a banner, but leaves empty space on both left and right sides. Currently, the following sections are missing: Table of Contents, Features, and installation guides for specific distributions. I haven't created any The installation shell scripts are currently placeholders, but we could actually make them functional, which would shorten the installation command/link. We can also a few more sections like, Usage, Star History, A Comparison Table of Features, etc. https://github.com/codayon/openbangla-keyboard/blob/docs/rewrite-readme/README.md |
|
I think we should move from Hugo + mdBook to something more suitable for our needs. It can be Docusaurus, Starlight or VitePress. Which can help us to manage landing page, docs and blogs in the same repository. |
|
Have you tried out https://www.fumadocs.dev/ ? |
Not yet, but looks sleek. |
|
Seems like Fumadocs, is mainly focused on UI and docs. It lacks features such as versioning, blogs, search, that are pre-built on something like Docusaurus. |
|
@codayon Can you build a demo using Docusaurus? I think we should move this discussion into the discussions page. |
|
Closes: #441