You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-1Lines changed: 5 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,4 +4,8 @@ This library provides scripts for parsing a given directory for Discourse AppEve
4
4
5
5
1. Create a .env file and set DISCOURSE_CORE to the desired directory path to be parsed.
6
6
7
-
2. Run the script from root of this repo with node scripts/extract_app_events.mjs
7
+
2. Run the script from root of this repo with `node scripts/extract_app_events.mjs`. This writes the raw data to `app_events_details.json` and a list of appEvent IDs to `event-ids.yml`.
8
+
9
+
3. Optional: Inject JSDoc-style documentation for each callsite of AppEvents.trigger with `node scripts/add_app_events_docs_to_discourse.mjs`. This changes the line number references for each callsite, so be sure to run `node scripts/extract_app_events.mjs` after to update the line numbers for the raw `app_events_details.json` file.
10
+
11
+
4. Run `node scripts/create_app_events_doc_markdown.mjs` to generate a markdown-formatted (GFM) file with consolidated AppEvents documentation, written to `app_events_doc.md`. This can be used to update [discourse-developer-docs](https://github.com/discourse/discourse-developer-docs).
0 commit comments