Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve API documentation #2229

Open
villesau opened this issue Dec 25, 2023 · 1 comment
Open

Improve API documentation #2229

villesau opened this issue Dec 25, 2023 · 1 comment
Labels
type: bug 🪲 Something isn't working

Comments

@villesau
Copy link

villesau commented Dec 25, 2023

Summary

Looks like there's a massive API surface, but very minimal documentation. All the components and hooks are listed, but there's not much information about them. For example the core component, Remirror: https://remirror.io/docs/api/react-core#interface-remirrorprops and https://remirror.io/docs/api/react-core#interface-remirrorprops is not documented almost at all. Some of the props that are mentioned elsewhere in the documentation (such as editable and initialContent) are lacking from the component specific docs. which makes it pretty hard to understand what is the actual api surface of the component, and what possibilities it actually offers. I believe this might block people from getting started with the editor as it makes getting your head around it pretty hard.

@villesau villesau added the type: bug 🪲 Something isn't working label Dec 25, 2023
@satokenta940
Copy link

You might want to try Apidog for generating documents. Its user interface is designed to be intuitive, making it easy for newcomers to understand and get started, which is a significant advantage.



Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: bug 🪲 Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants