search

nodemailer / nodemailer-web

Source for www.nodemailer.com
https://nodemailer.com
MIT License
7 stars 18 forks source link

RFC: Migration to Docusaurus for Documentation Website #24

Open hichemfantar opened 9 months ago

hichemfantar commented 9 months ago

RFC: Migration to Docusaurus for Documentation Website

Status: Proposed

Overview

The purpose of this RFC is to propose the migration of the existing documentation website to Docusaurus, a modern static site generator designed for documentation sites. Docusaurus provides a user-friendly and customizable framework that can enhance the overall user experience and simplify the maintenance of documentation.

Motivation

  1. Improved User Experience: Docusaurus offers a clean and responsive design, making it easier for users to navigate and find the information they need.

  2. Ease of Maintenance: Docusaurus simplifies the process of updating and maintaining documentation. Its markdown-based content structure allows for easy editing and versioning.

  3. Search Functionality: Docusaurus comes with built-in search functionality, providing users with a quick and efficient way to search for relevant information.

  4. Customization: Docusaurus allows for extensive customization, enabling us to tailor the look and feel of the documentation to match branding and user expectations.

  5. Versioning Support: Docusaurus has built-in support for versioning documentation, making it seamless to maintain and access different versions of the documentation.

  6. Internationalization (i18n): Docusaurus provides built-in support for internationalization, enabling us to create and manage content in multiple languages. This ensures a more inclusive experience for users worldwide.

  7. Blog: Docusaurus provides built-in support for blogging, enabling us to deploy a full-featured blog in no time.

Proposed Changes

  1. Install and Configure Docusaurus:

    • Set up a new Docusaurus project.
    • Configure Docusaurus to match branding and style guidelines.
    • Integrate any necessary plugins for additional functionality.

  2. Content Migration:

    • Migrate existing documentation content to the Docusaurus project.
    • Update and reorganize content as needed to align with Docusaurus conventions.

  3. Navigation and Structure:

    • Review and update the navigation structure for improved accessibility.
    • Ensure that the information architecture is logical and user-friendly.

  4. Search Integration:

    • Implement and configure Docusaurus's built-in search functionality.
    • Optimize search settings for accurate and relevant results.

  5. Versioning:

    • Utilize Docusaurus versioning features to manage multiple versions of the documentation.
    • Ensure that users can easily switch between different versions of the documentation.

  6. Testing:

    • Conduct thorough testing of the new documentation site to identify and address any issues.
    • Test across different browsers and devices to ensure a consistent experience.

  7. Feedback and Iteration:

    • Gather feedback from internal and external users.
    • Iterate on the documentation based on feedback and continuously improve the user experience.

Conclusion

Migrating to Docusaurus offers numerous benefits in terms of user experience, maintenance, and functionality. The proposed changes aim to enhance the documentation platform, providing a more user-friendly and scalable solution.

References

Docusaurus Website

andris9 commented 9 months ago

Yes, I've already thought about moving to DocuSaurus once I have time for it. I used DocuSaurus with Github pages for https://sending.guide/ and it was quite convenient to use.

hichemfantar commented 9 months ago

@andris9 that sounds great! I'd more than happy to help with this endeavor. Also any plans to move the website inside the main nodemailer repo? It would make sense from an ease of maintainability perspective. This also seems the approach that a lot of popular open source projects are taking.