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.

Sign up for GitHub

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

Jump to bottom

Document public events in repo dev docs #4179

Closed
ssddanbrown opened this issue Apr 18, 2023 · 1 comment
Closed

Document public events in repo dev docs #4179

ssddanbrown opened this issue Apr 18, 2023 · 1 comment
Assignees
@ssddanbrown
Labels
📖 Docs Update :octocat: Admin/Meta
Milestone
v23.05

Comments

@ssddanbrown
Copy link
Member

ssddanbrown commented Apr 18, 2023 •
edited
Loading

Create a new dev docs file to document & detail all public JS-based events, such as the editor events.
Just so we have a document attached to code for developers to use, and a place to provide more detail to help users.

Would be good to document an event(/property?)-naming scheme.

Useful scraps

Docs changes

  • Should update "Hacking BookStack > Editor Events" docs section to be higher-level and point to this new doc.
@ssddanbrown ssddanbrown added this to the Next Feature Release milestone Apr 18, 2023
@ssddanbrown ssddanbrown self-assigned this Apr 18, 2023
ssddanbrown added a commit that referenced this issue Apr 20, 2023
@ssddanbrown
Documented public JS events used
c74f7cc 
Related to #4179
@ssddanbrown
Copy link
Member Author

Now added at https://github.com/BookStackApp/BookStack/blob/development/dev/docs/javascript-public-events.md.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@ssddanbrown ssddanbrown

Labels
📖 Docs Update :octocat: Admin/Meta
Milestone
v23.05
Development

No branches or pull requests
1 participant
@ssddanbrown