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

feat: Official Documentation page #615

Open
sdil opened this issue Feb 1, 2025 · 6 comments
Open

feat: Official Documentation page #615

sdil opened this issue Feb 1, 2025 · 6 comments
Assignees
Labels
enhancement feature New feature or request

Comments

@sdil
Copy link
Contributor

sdil commented Feb 1, 2025

Problem description
Although this Readme is good and concise, I think that many more users would have tried and adopt this library if we have a documentation page. This would lower the entry barrier for this library.

Solution description
Build a simple and concise documentation page, with basic search functionality. Something like https://fresh.deno.dev/docs/introduction and https://bun.sh/docs come to my mind.

Alternative solutions
Stick with Github readme.

Additional context
I could help kixkstart the new project and I could buy a domain for it. We could host on Cloudflare Pages which is effectively free

@sdil sdil added enhancement feature New feature or request labels Feb 1, 2025
@Tochemey
Copy link
Owner

Tochemey commented Feb 1, 2025

@sdil Thanks for bringing this up. I have honestly thought of doing that but the bandwith to start it.

@Tochemey
Copy link
Owner

Tochemey commented Feb 1, 2025

I suggest we use github pages or github wiki to start with.

@Tochemey
Copy link
Owner

Tochemey commented Feb 1, 2025

@sdil I think we should use GitBook https://docs.gitbook.com/getting-started/quickstart. Let me draft the doc structure and share

@Tochemey Tochemey self-assigned this Feb 9, 2025
@Tochemey
Copy link
Owner

Tochemey commented Feb 9, 2025

I believe the readme is quite extensive along with the Examples repo, this should get someone going. I am afraid to host some doc site that does not get updated when something changes.

@Tochemey
Copy link
Owner

Tochemey commented Feb 9, 2025

I have seen with other open source projects where the developer does not have any sponsorship that the doc is out of sync with the actual library. Because that is also demanding to maintain the docsite.

@sdil
Copy link
Contributor Author

sdil commented Feb 9, 2025

I'm more than happy to contribute to the documentation. I'm planning to write more tutorial blog posts on my personal blog. But if we have an official documentations, I'm more than happy to write them on the documentation itself.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement feature New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants