Create and Host Project Documentation using Docusaurus, Vercel, and Free Domain Registration

[Daniel-Boll]

The aim is to create comprehensive documentation for axum-js to aid developers in understanding, using, and contributing to the project. The documentation should be created using Docusaurus, hosted on Vercel, and accessible via a custom domain registered through Free Domain Registration with a *.is-an.app domain.

The documentation should be structured and include the following sections:

• Getting Started
• API Reference
• Usage Examples
• Contributing Guide
• FAQ

Steps:

1. Set up Docusaurus within a docs/ directory in the project.
2. Create content for the outlined sections.
3. Set up the project on Vercel for continuous deployment.
4. Register a *.is-an.app domain and configure it to point to the Vercel deployment.

Acceptance Criteria:

• Documentation is well-structured, informative, and covers the outlined sections.
• Docusaurus setup is correctly configured and styled.
• Vercel deployment is successful and continuous deployment is set up.
• Custom domain is registered, configured, and points to the Vercel deployment.
• Update README to include a link to the documentation website.
• Create a PR with the Docusaurus setup, content, and updated README.

Additional Context:

Creating thorough documentation is a crucial step for the growth and adoption of axum-js. Hosting this documentation on a dedicated, easily accessible site will provide a better user experience for developers.

[Daniel-Boll]

I am not sure if Free Domain Registration is working as of now, although there are other alternatives if none works fine for us, I temporarily will add it to axum-js.daniel-boll.me.

What we have by now 🤷,
Daniel Boll. 🎴

[Daniel-Boll]

Mintlify might be another good alternative

[AbdoALPOP]

👋 Hey Jaakko,

I am interested in your task and available to start immediately.

I am experienced with Docusaurus.io, Nextra, Mkdocs, and markdown. I can provide you with a user-friendly guide.

Here are some of my live guides:

• Redstone
• RHQ
• WashMaster User Guide

I'm looking forward to hearing from you soon 😃
Contact me and let's get started.

[Daniel-Boll]

Hello @AbdoALPOP,

Thank you for reaching out and expressing your interest in contributing to the documentation of the project. I appreciate your expertise in Docusaurus.io, Nextra, Mkdocs, and markdown, and your offer to create a user-friendly guide is highly valued.

Currently, the project is on hold due to high demands on my end. However, your enthusiasm and willingness to contribute are welcome. Feel free to start working on the documentation as you see fit. Your initiative in this regard is greatly appreciated.

I will keep your contact details and reach out once the project resumes. Your contributions until then would be a significant addition. Thank you once again for your offer and looking forward to potentially collaborating in the future.

Best regards,
Daniel Boll. 🎴