facebook / facebook/lexical

Improve Documentation

Open
#2,845 10 comments 5 reactions 0 assignees View on GitHub
contribution-week documentation enhancement
Dominant language
TypeScript
Stars
23.9k
Forks
2.2k
Avg merge
1d 14h
Merged PRs (30d)
55

Description

Generic Issue for Documentation Improvement.

- [x] Setup autogenerated API Docs
- [ ] Lexical lifecycle overview
Resources: https://www.youtube.com/watch?v=EwoS0dIx_OI
https://drafts.dio.la/article/lexical-state-updates
- [ ] Example: how to generate HTML from Lexical EditorState
- [ ] Example: how to use Commands/Transformers to disable core functionality
- [x] Example: how to set initial editor state
- [x] Example: how to set up collaborative editing
- [ ] API Docs: [lexical](https://lexical.dev/docs/api/modules/lexical)
- [x] API Docs: [@lexical/clipboard](https://lexical.dev/docs/api/modules/lexical_clipboard)
- [ ] API Docs: [@lexical/code](https://lexical.dev/docs/api/modules/lexical_code)
- [ ] API Docs: [@lexical/dragon](https://lexical.dev/docs/api/modules/lexical_dragon)
- [x] API Docs: [@lexical/file](https://lexical.dev/docs/api/modules/lexical_file)
- [x] API Docs: [@lexical/hashtag](https://lexical.dev/docs/api/modules/lexical_hashtag)
- [x] API Docs: [@lexical/headless](https://lexical.dev/docs/api/modules/lexical_headless)
- [x] API Docs: [@lexical/history](https://lexical.dev/docs/api/modules/lexical_history)
- [ ] API Docs: [@lexical/html](https://lexical.dev/docs/api/modules/lexical_html)
- [x] API Docs: [@lexical/link](https://lexical.dev/docs/api/modules/lexical_link)
- [x] API Docs: [@lexical/list](https://lexical.dev/docs/api/modules/lexical_list)
- [ ] API Docs: [@lexical/mark](https://lexical.dev/docs/api/modules/lexical_mark)
- [ ] API Docs: [@lexical/markdown](https://lexical.dev/docs/api/modules/lexical_markdown)
- [ ] API Docs: [@lexical/offset](https://lexical.dev/docs/api/modules/lexical_offset)
- [ ] API Docs: [@lexical/overflow](https://lexical.dev/docs/api/modules/lexical_overflow)
- [ ] API Docs: [@lexical/selection](https://lexical.dev/docs/api/modules/lexical_selection)
- [ ] API Docs: [@lexical/table](https://lexical.dev/docs/api/modules/lexical_table)
- [x] API Docs: [@lexical/text](https://lexical.dev/docs/api/modules/lexical_text)
- [x] API Docs: [@lexical/utils](https://lexical.dev/docs/api/modules/lexical_utils)
- [ ] API Docs: [@lexical/yjs](https://lexical.dev/docs/api/modules/lexical_yjs)
- [ ] API Docs: [DecoratorNode](https://lexical.dev/docs/api/classes/lexical.DecoratorNode)
- [ ] API Docs: [ElementNode](https://lexical.dev/docs/api/classes/lexical.ElementNode)
- [x] API Docs: [LexicalEditor](https://lexical.dev/docs/api/classes/lexical.LexicalEditor)
- [x] API Docs: [LexicalNode](https://lexical.dev/docs/api/classes/lexical.LexicalNode)
- [ ] API Docs: [LineBreakNode](https://lexical.dev/docs/api/classes/lexical.LineBreakNode)
- [ ] API Docs: [NodeSelection](https://lexical.dev/docs/api/classes/lexical.NodeSelection)
- [ ] API Docs: [ParagraphNode](https://lexical.dev/docs/api/classes/lexical.ParagraphNode)
- [x] API Docs: [RangeSelection](https://lexical.dev/docs/api/classes/lexical.RangeSelection)
- [ ] API Docs: [RootNode](https://lexical.dev/docs/api/classes/lexical.RootNode)
- [x] API Docs: [TextNode](https://lexical.dev/docs/api/classes/lexical.TextNode)

Others?

### Working with API Docs

We use typedoc to autogenerate API docs.

Check out what I did [here](https://github.com/facebook/lexical/pull/4033). If you go in and add similar comments to the functions in other files, they'll show up on the website. You can watch for changes and see them live by doing
```
npm run start:website
```
The changes will show up in the section you get to by clicking "API" in the site navigation.

Here are the typedoc docs: https://typedoc.org/guides/declaration-references/

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.