Skip to content

Commit

Permalink
Fix doc typos
Browse files Browse the repository at this point in the history
  • Loading branch information
etrepum committed Apr 14, 2024
1 parent b7139d1 commit d94ebb1
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions packages/lexical-website/docs/maintainers-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,20 +40,25 @@ not ready for consumption, it should probably still be set to
| Usage | Convention |
| -- | -- |
| Directory name | `packages/lexical-package-name` |
| Entrypoint | `packages/lexical-package-name/index.ts` |
| Flow types | `packages/lexical-package/flow/LexicalPackage.js.flow` |
| Entrypoint | `packages/lexical-package-name/src/index.{ts,tsx}` |
| Flow types | `packages/lexical-package/flow/LexicalPackageName.js.flow` |
| package.json name | `@lexical/package-name` |
| Documentation | `packages/lexical-package-name/README.md` |
| Unit Tests | `packages/lexical-package-name/src/__tests__/unit/LexicalPackageName.test.{ts,tsx}` |
| dist (gitignore'd build product) | `packages/lexical-package-name/dist` |
| npm (gitignore'd prerelease product) | `packages/lexical-package-name/npm` |
| www entrypoint? | `packages/lexical-package-name/LexicalPackageName.js` |

### Multiple module export (@lexical/react)

Instead of having a single module, some packages may have many modules
(currently only `@lexical/react`) that are each exported separately.
In that scenario, there should be no `index.ts` file and every module
In that scenario, there should be no `index.ts` entrypoint file and every module
at the top-level should be an entrypoint. All entrypoints should be a
TypeScript file, not a subdirectory containing an index.ts file.

The [update-packages](#npm-run-update-packages) script will ensure that the exports match the files
on disk.
The [update-packages](#npm-run-update-packages) script will ensure that the
exports match the files on disk.

## Scripts for development

Expand Down

0 comments on commit d94ebb1

Please sign in to comment.