Skip to content

Provide Documentation for 6.0 and Above #885

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

Closed
commonsensesoftware opened this issue Oct 4, 2022 · 4 comments
Closed

Provide Documentation for 6.0 and Above #885

commonsensesoftware opened this issue Oct 4, 2022 · 4 comments

Comments

@commonsensesoftware
Copy link
Collaborator

Several breaking changes have been made since the 6.0 release. Although the code examples have been updated, the documentation (e.g. wiki) has not. The documentation should provide the up-to-date information.

@andyfurniss4
Copy link

andyfurniss4 commented Nov 22, 2022

Would approve of this. Just spent a while trying to figure out why various methods were not available to me when referring to the wiki.

EDIT: Also, all the 'example' links for the API Explorers on this page are broken which, when coupled with the outdated wiki gives no easy way to figure out how to configure the API Explorer stuff.

@commonsensesoftware
Copy link
Collaborator Author

Sorry about that. Documentation is important, but as a one man show, I have limits. My top priority is making sure no one is blocked. The best reference is the example projects. They are always up to date.

@andyfurniss4
Copy link

No worries! I read the background so I understand your position and I know documentation is everyone's least favourite job! 😆

I will refer to the example projects from now on. Thank you!

@commonsensesoftware
Copy link
Collaborator Author

If you're following this issue or you stumbled across it, all of the documentation should now be up-to-date. There are even new topics such as the client-side extensions. If you find any errors or omissions, feel free to post them here or open a new issue.

Some time in the future, I may build out a fully-fledged documentation site. I'm even considering writing a book because I think there is enough content and details to do so. Creating some videos is on my bucket list this year. Stay tuned. 😉

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