File tree Expand file tree Collapse file tree 1 file changed +27
-0
lines changed Expand file tree Collapse file tree 1 file changed +27
-0
lines changed Original file line number Diff line number Diff line change @@ -184,6 +184,33 @@ INSERT INTO bad_words (word) VALUES
184
184
` psql postgres://127.0.0.1:5433/registry --user [your username] -f bad_words.sql ` ,
185
185
and provide the password for the provided username.
186
186
187
+ ### Contributing to documentation generation
188
+
189
+ The documentation generation is done via
190
+ [ ` deno_doc ` ] ( https://github.com/denoland/deno_doc ) .
191
+
192
+ To be able to use a local ` deno_doc ` clone in jsr, you need to add this to the
193
+ root ` Cargo.toml ` in this repository:
194
+
195
+ ``` toml
196
+ [patch .crates-io ]
197
+ deno_doc = { path = " ../deno_doc" }
198
+ ```
199
+
200
+ Please make sure that the version of ` deno_doc ` you have locally is the same
201
+ version as the one referenced in ` api/Cargo.toml ` , else the patching will not
202
+ work.
203
+
204
+ Please open PRs in the ` deno_doc ` repository when it is changes that should
205
+ affect the overall documentation generation system, even if it is only for css
206
+ changes, with a few minor exceptions when the css changes are related to the
207
+ integration and layouting specific for jsr alone.
208
+
209
+ For more information on how the HTML documentation generation works and how to
210
+ locally work on it, please see the
211
+ [ HTML development section] ( https://github.com/denoland/deno_doc?tab=readme-ov-file#html-generation )
212
+ of ` deno_doc ` .
213
+
187
214
### Other
188
215
189
216
During local dev, traces are sent to Jaeger. You can view them at
You can’t perform that action at this time.
0 commit comments