search

paranext / paranext-core

Electron client, extension host, and C# library for Paranext
https://paranext.github.io/paranext-core/
MIT License
17 stars 2 forks source link

Request to add high-level documentation on components props and functionality in Platform-bible-react library #1269

Open roopa0222 opened 3 weeks ago

roopa0222 commented 3 weeks ago

User Story As an extension developer, I want to have documentation on the platform-bible-react library components to have a good understanding of their features (props) and functionality

Description

  1. Adding more information on the props and attributes in a custom component will be helpful.
  2. In cases where a component is built based on a third party, providing that information gives more access to documentation and usage. Ex : In MarkdownRenderer, https://github.com/quantizor/markdown-to-jsx is used to build the component

Some of the component's usage is not self-explanatory. Screenshot 2024-11-06 102859