Git Product home page Git Product logo

nodemailer-web's Issues

Example for URL uses "path" instead of "href"

In the provided example "path" is used instead of "href". This resulted in a slight confusion when trying to implement an attachment with an URL.

{   // use URL as an attachment
            filename: 'license.txt',
            path: 'https://raw.github.com/nodemailer/nodemailer/master/LICENSE'
},

should be

{   // use URL as an attachment
            filename: 'license.txt',
            href: 'https://raw.github.com/nodemailer/nodemailer/master/LICENSE'
},

Remove "Pricing" page?

We got a little confused today after googling "nodemailer pricing" and ending up on https://nodemailer.com/about/pricing/

After a bit of thought, I figured this is a fragment from the past when nodemailer used the EUPL, correct me if I'm wrong.

Maybe this page should be removed to not confuse users?

RFC: Migration to Docusaurus for Documentation Website

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

"SMTP > Well-known services" page status

I was wondering why https://nodemailer.com/smtp/well-known/ have a bit different layout than the rest of the page and why it's not visible in the side navigation.

I see in the source that this page is stored in static directory as HTML file, probably there was no time to rewrite it to markdown, but it shouldn't prevent from listing it in the side navigation ๐Ÿค”

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.