Update README.org #3
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the README.org documentation to enhance project clarity and provide important stability information. The changes focus on improving the introduction and adding a development status notice.
Key Changes:
- Added comprehensive introductory section describing the package's purpose, current capabilities, and future roadmap
- Added important notice about package stability and contribution opportunities
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| #+end_src | ||
|
|
||
| > [!IMPORTANT] | ||
| > This package is not stable yet, is still under develop, however |
There was a problem hiding this comment.
Corrected spelling of 'develop' to 'development'.
| > This package is not stable yet, is still under develop, however | |
| > This package is not stable yet, is still under development, however |
|
|
||
| > [!IMPORTANT] | ||
| > This package is not stable yet, is still under develop, however | ||
| > if you are interested on support it and contribute you can do it. |
There was a problem hiding this comment.
Grammatical error: 'interested on support' should be 'interested in supporting'.
| > if you are interested on support it and contribute you can do it. | |
| > if you are interested in supporting it and contributing, you can do it. |
| > [!IMPORTANT] | ||
| > This package is not stable yet, is still under develop, however | ||
| > if you are interested on support it and contribute you can do it. | ||
| > [https://github.com/kyonax/org2html](Github Repo org2html) |
There was a problem hiding this comment.
The text 'Github' should be 'GitHub' with proper capitalization.
| > [https://github.com/kyonax/org2html](Github Repo org2html) | |
| > [https://github.com/kyonax/org2html](GitHub Repo org2html) |
| > [!IMPORTANT] | ||
| > This package is not stable yet, is still under develop, however | ||
| > if you are interested on support it and contribute you can do it. | ||
| > [https://github.com/kyonax/org2html](Github Repo org2html) |
There was a problem hiding this comment.
The [!IMPORTANT] syntax and blockquote formatting appear to be GitHub-flavored Markdown, which may not render correctly in Org-mode. Consider using native Org-mode syntax such as #+begin_quote blocks or #+begin_warning for proper rendering in Org documents.
| > [!IMPORTANT] | |
| > This package is not stable yet, is still under develop, however | |
| > if you are interested on support it and contribute you can do it. | |
| > [https://github.com/kyonax/org2html](Github Repo org2html) | |
| #+begin_warning | |
| This package is not stable yet, is still under development. However, | |
| if you are interested in supporting it and contributing, you can do so. | |
| [[https://github.com/kyonax/org2html][Github Repo org2html]] | |
| #+end_warning |
No description provided.