Document public events in repo dev docs #3750

Closed
opened 2026-02-05 07:19:46 +03:00 by OVERLORD · 1 comment
Owner

Originally created by @ssddanbrown on GitHub (Apr 18, 2023).

Originally assigned to: @ssddanbrown on GitHub.

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.
Originally created by @ssddanbrown on GitHub (Apr 18, 2023). Originally assigned to: @ssddanbrown on GitHub. 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 - See CM6 theme example here: https://github.com/BookStackApp/BookStack/pull/3617#issuecomment-1509859003 ### Docs changes - Should update "Hacking BookStack > Editor Events" docs section to be higher-level and point to this new doc.
OVERLORD added the 📖 Docs Update:octocat: Admin/Meta labels 2026-02-05 07:19:46 +03:00
Author
Owner

@ssddanbrown commented on GitHub (Apr 20, 2023):

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

@ssddanbrown commented on GitHub (Apr 20, 2023): Now added at https://github.com/BookStackApp/BookStack/blob/development/dev/docs/javascript-public-events.md.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/BookStack#3750