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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Alternative to API bullet points #923

Open
semoal opened this issue Aug 11, 2021 · 4 comments
Open

Alternative to API bullet points #923

semoal opened this issue Aug 11, 2021 · 4 comments

Comments

@semoal
Copy link
Member

semoal commented Aug 11, 2021

馃摎 Documentation

Right now we specify the API of plugins and some internal concepts with bullet points, but I noticed that is complex to read and even worse to understand which values accepts.

Screenshot 2021-08-11 at 10 43 57 PM

We should investigate a bit on other tools to see which options are better to our use case.

@tianzhich
Copy link
Collaborator

I think it's ok. Why do you think it's complex and worse to understand?

@semoal
Copy link
Member Author

semoal commented Aug 12, 2021

The readability is not cool. Just want to explore other alternatives to make it easier, more readable and more beauty

@tianzhich
Copy link
Collaborator

The readability is not cool. Just want to explore other alternatives to make it easier, more readable and more beauty

I referred to the Redux doc site. I think they are similar to us.

ksat8384 added a commit to ksat8384/rematch that referenced this issue Dec 3, 2021
 Alternative to API bullet points [rematch#923]
ksat8384 added a commit to ksat8384/rematch that referenced this issue Dec 3, 2021
ksat8384 added a commit to ksat8384/rematch that referenced this issue Dec 3, 2021
docs: Added Alternative to API bullet points rematch#923
@stale
Copy link

stale bot commented Apr 16, 2022

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the wontfix label Apr 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants