Skip to content

Commit 88a76ab

Browse files
committed
update README
1 parent 38c5c93 commit 88a76ab

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,8 @@ This library provides scripts for parsing a given directory for Discourse AppEve
44

55
1. Create a .env file and set DISCOURSE_CORE to the desired directory path to be parsed.
66

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

Comments
 (0)