Skip to content

Commit 989525b

Browse files
AlexVarchukRomanHotsiyOpryskivankropyvnytskyiyevhenpylyp-del
committed
feat: initialize release candidate for v3.0.0
Co-authored-by: Roman Hotsiy <[email protected]> Co-authored-by: Alex Varchuk <[email protected]> Co-authored-by: Oprysk Vyacheslav <[email protected]> Co-authored-by: Ivan Kropyvnytskyi <[email protected]> Co-authored-by: Yevhen Pylyp <[email protected]> Co-authored-by: Vladyslav Makarenko <[email protected]> Co-authored-by: Yevhenii Medviediev <[email protected]> Co-authored-by: Oleksii Horbachevskyi <[email protected]> Co-authored-by: volodymyr-rutskyi <[email protected]> Co-authored-by: Adam Altman <[email protected]> Co-authored-by: Andrew Tatomyr <[email protected]> Co-authored-by: Anastasiia Derymarko <[email protected]> Co-authored-by: Roman Marshevskyy <[email protected]> Co-authored-by: Lorna Mitchell <[email protected]> Co-authored-by: Taylor Krusen <[email protected]>
1 parent 3462357 commit 989525b

File tree

773 files changed

+140037
-84205
lines changed

Some content is hidden

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

773 files changed

+140037
-84205
lines changed

.changeset/config.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
3+
"changelog": "@changesets/cli/changelog",
4+
"commit": false,
5+
"fixed": [["redoc"]],
6+
"linked": [],
7+
"access": "public",
8+
"baseBranch": "main",
9+
"updateInternalDependencies": "patch"
10+
}

.dockerignore

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,8 @@
11
*
22
!src/
3-
!config
4-
!demo/favicon.png
5-
6-
!custom.d.ts
7-
!typings/styled-patch.d.ts
8-
!tsconfig.json
9-
!webpack.config.ts
10-
3+
!scripts/
114
!package.json
125
!package-lock.json
6+
!vite.config.ts
7+
!tsconfig.json
8+
!config/

.editorconfig

Lines changed: 0 additions & 10 deletions
This file was deleted.

.eslintrc.js

Lines changed: 0 additions & 54 deletions
This file was deleted.

.github/CODEOWNERS

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
1-
* @Redocly/keyboard-warriors
2-
/docs/ @Redocly/technical-writers
1+
* @Redocly/keyboard-warriors

.github/CONTRIBUTING.md

Lines changed: 16 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,11 @@ Before submitting a pull request, please make sure the following is done:
2020
2. Run `npm install` in the repository root.
2121
3. If you’ve fixed a bug or added code that should be tested, add tests!
2222
4. Ensure the test suite passes (`npm test`). Tip: `npm test -- --watch TestName` is helpful in development.
23-
5. Format your code with prettier (`npm run prettier`).
23+
5. Lint your code with eslint (`npm run lint`).
2424

2525
## Development Setup
2626

27-
You need [Node.js](http://nodejs.org) at `v12.0.0+`.
27+
You need [Node.js](http://nodejs.org) at `Node LTS+`.
2828

2929
After cloning the repo, run:
3030

@@ -38,61 +38,49 @@ $ npm install # or npm
3838
# dev-server, watch and auto reload playground
3939
$ npm start
4040

41-
# start playground app in production environment
42-
$ npm run start:prod
43-
44-
# runt tslint
41+
# run tslint
4542
$ npm run lint
4643

4744
# try autofix tslint issues
48-
$ npm run lint -- --fix
45+
$ npm run lint:fix
4946

5047
# run unit tests
5148
$ npm run unit
5249

5350
# run e2e tests
5451
$ npm run e2e
5552
# Make sure you have created bundle before running e2e test
56-
# E.g. run `npm run bundle` and wait for the finishing process.
53+
# E.g. run `npm run build` and wait for the finishing process.
5754

58-
# open cypress UI to debug e2e test
59-
$ npm run cy:open
55+
# open Playwright UI to debug e2e test
56+
$ npm run e2e:ui
6057

6158
# run the unit tests (includes linting and license checks)
6259
$ npm test
6360

6461
# prepare bundles
65-
$ npm run bundle
66-
67-
# format the code using prettier
68-
$ npm run prettier
62+
$ npm run build
6963

70-
# auto-generate changelog
71-
$ npm run changelog
7264
```
7365

7466
There are some other scripts available in the `scripts` section of the `package.json` file.
7567

7668
## Project Structure
7769

78-
- **`benchmark`**: contains basic perf benchmark. Not fully ready yet
70+
- **`examples`**: contains project demos
7971

80-
- **`demo`**: contains project demo with demo specs and HMR playground used in development
81-
82-
- `demo/playground`: HMR Playground used in development
72+
- **`playground`**: HMR Playground used in development
8373

8474
- **`docs`**: contains extra docs (linked from README.md)
8575

86-
- **`e2e`**: contains e2e tests. The e2e tests are written and run with [Cypress](https://www.cypress.io/).
87-
76+
- **`playwright`**: contains e2e tests. The e2e tests are written and run with [Playwright](https://playwright.dev/).
8877

89-
- **`src`**: contains the source code. The codebase is written in Typescript. CSS styles are managed with [Styled components](https://www.styled-components.com/). State is managed by [MobX](https://github.com/mobxjs/mobx)
78+
- **`src`**: contains the source code. The codebase is written in Typescript. CSS styles are managed with [Styled components](https://www.styled-components.com/). State is managed by [Jotai](https://github.com/pmndrs/jotai)
9079

91-
- **`src/common-elements`**: contains common Styled elements or components used in multiple places
9280
- **`src/components`**: contains main visual components
93-
- **`src/services`**: contains different services used by Redoc including MobX stores
94-
- **`src/services/models`**: contains classes for OpenAPI entities (e.g. Response, Operations, etc)
81+
- **`src/services`**: contains different services used by Redoc including Jotai stores
82+
- **`src/models`**: contains classes for OpenAPI entities (e.g. Response, Operations, etc)
9583
- **`src/types`**: contains extra typescript typings including OpenAPI doc typings
9684
- **`src/utils`**: utility functions
97-
- **`src/styled-components.ts`**: - reexports styled-components with proper typescript annotations using theme
98-
- **`src/theme.ts`**: - default theme (colors, fonts, etc) used by all the components
85+
- **`src/jotai`**: - contains Jotai store files
86+
- **`src/hooks`**: - contains global react hooks for application

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,12 @@ A clear and concise description of what you expected to happen.
1515

1616
**Minimal reproducible OpenAPI snippet(if possible)**
1717

18+
19+
**Version (of Redoc, Node, OS, Browser)**
20+
21+
1822
**Screenshots**
1923
If applicable, add screenshots to help explain your problem.
2024

2125
**Additional context**
22-
Add any other context about the problem here.
26+
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,4 @@ A clear and concise description of what you want to happen.
1717
A clear and concise description of any alternative solutions or features you've considered.
1818

1919
**Additional context**
20-
Add any other context or screenshots about the feature request here.
20+
Add any other context or screenshots about the feature request here.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: Get version from package.json
2+
description: Get version from package.json
3+
outputs:
4+
value:
5+
description: "Version from package.json"
6+
value: ${{ steps.package_version.outputs.value }}
7+
runs:
8+
using: composite
9+
steps:
10+
- name: Get version
11+
shell: bash
12+
id: package_version
13+
run: |
14+
echo "value=$(jq -r .version package.json)" >> "$GITHUB_OUTPUT"
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
name: Node setup
2+
description: Setup Node
3+
runs:
4+
using: composite
5+
steps:
6+
- name: 🚀 Starting Node setup
7+
shell: bash
8+
run: |
9+
echo -e "\033[32m----- setup Node started -----\033[0m"
10+
echo "START_TIME=$(date +%s)" >> $GITHUB_ENV
11+
- name: 📦 Install Node
12+
uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4
13+
with:
14+
node-version: 22.17.1
15+
cache: npm
16+
- name: ✅ Finished Node setup
17+
shell: bash
18+
run: |
19+
END_TIME=$(date +%s)
20+
DURATION=$((END_TIME - START_TIME))
21+
echo -e "\033[32m----- setup Node finished in ${DURATION}s -----\033[0m"

0 commit comments

Comments
 (0)