To enhance our application's documentation and user guidance within the UI, I propose the implementation of a feature that automatically fetches and converts a project's README.md file to HTML. This will then be displayed within the application, specifically stored in a property called description.
Description
Many projects host their documentation in a README.md file at the root of their repository. This documentation is often the first point of reference for users or developers new to the project. However, viewing this documentation requires navigating away from the application to the project's repository. To streamline access to this vital information, I suggest we introduce a new capability within our React application:
Specification Addition: Introduce a new property within the app's configuration, named notes.readmeUrl. This property will hold a URL pointing to the raw README.md file of the project.
Functionality: When the application loads (or at a specified trigger point), it will check if notes.readmeUrl is set and points to a valid Markdown file. If so, the application will fetch the Markdown content, convert it into HTML, and then store this HTML content within the description property of the app's specification.
Display: The HTML-converted README.md content will be presented to users in a dedicated section of the application, ensuring easy access to documentation without leaving the application environment.
🚀 Feature Request
To enhance our application's documentation and user guidance within the UI, I propose the implementation of a feature that automatically fetches and converts a project's README.md file to HTML. This will then be displayed within the application, specifically stored in a property called description.
Description
Many projects host their documentation in a README.md file at the root of their repository. This documentation is often the first point of reference for users or developers new to the project. However, viewing this documentation requires navigating away from the application to the project's repository. To streamline access to this vital information, I suggest we introduce a new capability within our React application: