Skip to content

Commit 4620b24

Browse files
arnautov-antonarnautov-anton
authored
docs: restructuring (GetStream#2250)
### 🎯 Goal Restructure documentation following new structures of iOS and RN. TODO: - [ ] move certain content to proper places (both files and certain paragraphs/articles) - [x] We'll need to start using [`sidebars-react.json`](https://github.com/GetStream/stream-chat-swift/blob/develop/docusaurus/sidebars-ios.json) (iOS one for reference) as folder structure which looks like this: ![image](https://github.com/GetStream/stream-chat-react/assets/43254280/0a4fd24d-cc23-4dd9-9ee4-c6564ff9634d) generates a sidebar which looks like this: ![image](https://github.com/GetStream/stream-chat-react/assets/43254280/259f8ca2-40f1-4e09-926f-5ace7df93016) making <Message List> dropdown also a clickable link which navigates to the content - which is not what we want - and content id's are not respected. (notice size of carets in this one and font of "Attachment" is also different from others) ![image](https://github.com/GetStream/stream-chat-react/assets/43254280/082ea6ab-bca0-434b-8c44-26b7e75eac1b)
1 parent e086565 commit 4620b24

294 files changed

Lines changed: 18999 additions & 1012 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/release.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ jobs:
6767
- name: Install dependencies
6868
run: yarn install --frozen-lockfile --ignore-engines --ignore-scripts
6969
- name: Merge shared "@stream-io/stream-chat-css" docs
70-
run: bash scripts/merge-stream-chat-css-docs.sh node_modules/@stream-io/stream-chat-css/docs
70+
run: yarn docs:copy-css-docs
7171
- name: Push to stream-chat-docusaurus
7272
uses: GetStream/push-stream-chat-docusaurus-action@main
7373
with:

‎developers/DOCUMENTATION.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ If you are introducing changes impacting the API or behavior of the SDK parts, y
1010

1111

1212
```bash
13-
yarn docs-run
13+
yarn docs:run
1414
```
1515

1616
## Documentation patterns

‎docusaurus/docs/React/assets/custom-emoji-picker.png‎

22.9 KB
Loading

‎docusaurus/docs/React/assets/default-channel-header.png‎

7.15 KB
Loading

‎docusaurus/docs/React/assets/default-channel-list.png‎

41.1 KB
Loading

‎docusaurus/docs/React/assets/default-emoji-picker.png‎

131 KB
Loading

‎docusaurus/docs/React/assets/default-message-input.png‎

6.45 KB
Loading

‎docusaurus/docs/React/assets/default-message-list.png‎

230 KB
Loading

‎docusaurus/docs/React/assets/default-thread.png‎

352 KB
Loading

‎docusaurus/docs/React/assets/reaction-selector-w-custom-options.png‎

18.5 KB
Loading

0 commit comments

Comments
 (0)