Skip to content

docs: rewrite README from adoc to md with improvements#442

Draft
codayon wants to merge 3 commits intoOpenBangla:developfrom
codayon:docs/rewrite-readme
Draft

docs: rewrite README from adoc to md with improvements#442
codayon wants to merge 3 commits intoOpenBangla:developfrom
codayon:docs/rewrite-readme

Conversation

@codayon
Copy link
Copy Markdown
Contributor

@codayon codayon commented Jan 21, 2026

Closes: #441

@codayon
Copy link
Copy Markdown
Contributor Author

codayon commented Jan 22, 2026

@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 .bn.md files yet because I think it might over-complicate things right now. To make maintenance smoother, I believe we should focus on one language for now. Let me know your thoughts on that.

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

@codayon
Copy link
Copy Markdown
Contributor Author

codayon commented Jan 22, 2026

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.

@mominul
Copy link
Copy Markdown
Member

mominul commented Jan 22, 2026

Have you tried out https://www.fumadocs.dev/ ?

@codayon
Copy link
Copy Markdown
Contributor Author

codayon commented Jan 22, 2026

Have you tried out https://www.fumadocs.dev/ ?

Not yet, but looks sleek.

@codayon
Copy link
Copy Markdown
Contributor Author

codayon commented Jan 22, 2026

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.

@mominul
Copy link
Copy Markdown
Member

mominul commented Jan 24, 2026

@codayon Can you build a demo using Docusaurus? I think we should move this discussion into the discussions page.

@codayon
Copy link
Copy Markdown
Contributor Author

codayon commented Jan 24, 2026

I think we should move this discussion into the discussions page.

#396 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants