Skip to content

Commit 163e097

Browse files
committed
finish
1 parent 84aa3dc commit 163e097

File tree

1 file changed

+17
-1
lines changed
  • contributor_docs/pr05_2025_typescript_migration

1 file changed

+17
-1
lines changed

contributor_docs/pr05_2025_typescript_migration/index.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ This is the project appendix for the **2025 pr05 Grant: Incremental Typescript M
44

55
## Additional Reading:
66

7+
- [All PRs related to the pr05 grant can be found with the `pr05` tag](https://github.com/processing/p5.js-web-editor/issues?q=state%3Aclosed%20label%3A%22pr05%20Grant%20Projects%22)
78
- [pr05 grant](https://github.com/processing/pr05-grant/wiki/2025-pr05-Program-Page)
89
- [pr05 grant: Typescript Migration Project](https://github.com/processing/pr05-grant/wiki/2025-pr05-Project-List#incremental-typescript-migration-for-the-p5js-editor)
910
- [Intro to the Incremental Typescript Migration for the p5.js Web Editor](https://medium.com/@clairepeng94/intro-to-the-incremental-typescript-migration-for-the-p5-js-web-editor-2ffbc305c6a9)
@@ -387,6 +388,20 @@ export const updatePreferences: RequestHandler<
387388

388389
## Configuration Summary:
389390

391+
<details>
392+
<summary>
393+
Relevant PRs
394+
</summary>
395+
396+
- [pr05 Typescript #1: Set up TS dependencies in the root & client](https://github.com/processing/p5.js-web-editor/pull/3533)
397+
- [pr05 Typescript #2: automatically resolve imports of ts files & migrate instance of client/utils file](https://github.com/processing/p5.js-web-editor/pull/3540)
398+
- [pr05 Typescript Migration #10: Setup Server TS Dependencies & migrate instance of server file](https://github.com/processing/p5.js-web-editor/pull/3636)
399+
- [pr05 Typescript Migration #15: Redux base files & migrate user preferences redux system](https://github.com/processing/p5.js-web-editor/pull/3683)
400+
- [pr05 Typescript Migration #16: Fix build error webpack example config](https://github.com/processing/p5.js-web-editor/pull/3696)
401+
- [pr05 Typescript Migration #17: Add typecheck to ci](https://github.com/processing/p5.js-web-editor/pull/3699)
402+
403+
</details>
404+
390405
## Migration Tutorial:
391406

392407
[Video Guide - Migrating the `client/modules/User/pages/AccountView`](youtube.com/watch?v=y84SVy7lAgg&feature=youtu.be)
@@ -530,10 +545,11 @@ export const updatePreferences: RequestHandler<
530545
</details>
531546

532547
<details>
533-
<summary>Create a [OpenAPI/Swagger](https://swagger.io/tools/swagger-ui/) documentation microsite for the server APIs</summary>
548+
<summary>Create a OpenAPI/Swagger documentation microsite for the server APIs</summary>
534549

535550
<img src='./images/swagger-microsite.png' alt='proof of concept of a swagger documentation microsite'>
536551

552+
- [Swagger.ui](https://swagger.io/tools/swagger-ui/)
537553
- [Issue Link - TODO]()
538554

539555
- This would enable new contributors to have a centralised location to look for APIs

0 commit comments

Comments
 (0)