Lorna Jane Mitchell
4fd22f6d74
docs: Add docs tooling to align with publishing to main site ( #2484 )
...
* docs: add markdownlint and some link checks alongside vale
* docs: add link checker config and fix/update some links reported broken
* docs: update markdownlint action
* docs: fix markdown table formatting
* docs: Unpin Vale version and pick up the latest
2024-01-29 16:39:44 +00:00
Javi Rubio
21b961dffa
Add Quaderno API to README's Showcase section ( #2468 )
2023-12-28 15:38:40 +00:00
Lorna Jane Mitchell
0db1e9872d
docs: Remove references to interactive docs in the open source project ( #2460 )
...
* docs: Remove references to interactive docs in the open source project
* Update README.md
Co-authored-by: Adam Altman <adam@redoc.ly>
---------
Co-authored-by: Adam Altman <adam@redoc.ly>
2023-12-01 16:00:50 +00:00
Alexei Maridashvili
e9f9799e89
Update README.md ( #2422 )
...
Fix link to deployment options
2023-11-13 11:48:58 +00:00
Lorna Jane Mitchell
b3503f2109
Config docs and README refresh ( #2393 )
...
* docs: Give Redoc a landing page with overview and tldr instructions
* docs: move config to dedicated page
* docs: modernise README, link to resources
* docs: more detailed format for theme configurations
* fix: README formatting
* fix: Fix future tense errors and add exceptions for config fields as headings
* Apply suggestions from code review
Co-authored-by: Heather Cloward <heathercloward@gmail.com>
* docs: minor updates from excellent pull request feedback
* docs: Remove the old quickstart, update HTML as the preferred onboarding method and improve docs/examples on that page
* Apply suggestions from code review
Co-authored-by: Heather Cloward <heathercloward@gmail.com>
---------
Co-authored-by: Heather Cloward <heathercloward@gmail.com>
2023-09-21 15:19:27 +01:00
Lorna Mitchell
d6eac394cf
docs: Remove Redoc CLI and a non-existent config option
2023-08-03 18:02:13 +03:00
Heather Cloward
c407726a66
docs: adds vale rules and workflow for running in CI ( #2348 )
...
* docs: adds vale rules and workflow for running in CI
* docs: updates product name from ReDoc to Redoc
2023-07-11 13:31:52 -04:00
Maryana Svitlyk
d3ad7925cf
feat: indicate whether request body is required or optional ( #2175 )
2023-03-06 20:41:41 +02:00
Alex Varchuk
2ae7e08af4
feat: add deprecation label to redoc-cli ( #2172 )
...
---------
Co-authored-by: Adam Altman <adam@redoc.ly>
2023-03-06 14:36:53 +02:00
Alex Varchuk
187e555558
chore: update link to redocly.com and add security to definition ( #2173 )
2022-10-12 15:28:08 +03:00
Waldir Pimenta
a2a4cf9554
chore: update capitalization in README: ReDoc → Redoc ( #2166 )
...
Also add missing punctuation to warning, and change example CDN link to the now-released 2.0.0
2022-09-19 11:54:28 +03:00
Alex Varchuk
5fb4daa618
chore: v2.0.0 ( #2160 )
2022-09-13 15:11:20 +03:00
Alex Varchuk
64cf624fff
chore: rename master branch to main ( #2163 )
2022-09-12 19:28:47 +03:00
pranitkhadilkar7
a366de4cf6
fix: handled style change in ServerUrl and ServersOverlay dynamically ( #1989 )
...
Co-authored-by: Alex Varchuk <olexandr.varchuk@gmail.com>
2022-06-01 14:48:16 +03:00
Anastasiia Derymarko
a863302cc8
feat: remove auth section ( #2022 )
2022-05-30 18:55:39 +03:00
Alex Varchuk
77104d6c0d
feat: add Redoc to Redocly CDN ( #2026 )
2022-05-30 13:40:19 +03:00
Loïc Fürhoff
ba06485ece
feat: theme add links textDecoration options ( #1599 )
...
Co-authored-by: Anastasiia Derymarko <anastasiia@redocly.com>
Co-authored-by: Loïc Fürhoff <loic.furhoff@pix4d.com>
2022-05-16 11:49:22 +03:00
Alex Varchuk
311d2ce64d
feat: add option to display verb in webhooks ( #1994 )
...
* chore: cli test run ts files
Co-authored-by: Ivana Isadora Devcic <33730345+skadinna@users.noreply.github.com>
2022-05-11 19:13:50 +03:00
Zach Whaley
b601c9ae9e
feat: Add download file option ( #1699 )
...
Co-authored-by: Zach Whaley <zachbwhaley@gmail.com>
Co-authored-by: Roman Hotsiy <gotsijroman@gmail.com>
Co-authored-by: anastasiia-developer <anastasiia@redocly.com>
Co-authored-by: Ivana Isadora Devcic <33730345+skadinna@users.noreply.github.com>
2022-05-10 20:09:01 +03:00
Adam Altman
42c91dc485
docs: update the README with correct links ( #1988 )
...
- Rename from OpenAPI CLI to Redocly CLI
- Fix links to Redoc quickstart and deployment guides.
2022-05-09 17:53:40 -05:00
Chintan Radia
0fa08faab1
feat: implement configurable minimum characer length to init search ( #1402 )
...
Co-authored-by: Alex Varchuk <olexandr.varchuk@gmail.com>
2022-05-03 10:48:08 +03:00
Loïc Fürhoff
6716b08e88
feat: theme add sidebar activeBackgroundColor and activeTextColor ( #1600 )
2022-04-07 16:51:52 +03:00
Quentin D
c75ac9cf70
feat: nonce support ( #1566 )
...
Signed-off-by: Quentin Devos <4972091+Okhoshi@users.noreply.github.com>
Co-authored-by: AlexVarchuk <olexandr.varchuk@gmail.com>
2022-03-23 18:02:30 +02:00
Ryc O'Chet
09786f2a5a
feat: Add support for displaying operationId in the sidebar ( #1927 )
...
* feat: Add support for displaying id in the sidebar
* fix: previous commit `feat: Add support for displaying id in the sidebar`
Co-authored-by: Oprysk <vyacheslav@redocly.com>
2022-03-23 12:39:26 +02:00
AlexVarchuk
30b3b57b26
chore: update docs about support IE 11 ( #1938 )
2022-03-21 15:51:23 +02:00
AlexVarchuk
635f379eb0
fix: improve customization fab ( #1891 )
2022-03-14 15:36:50 +02:00
AlexVarchuk
60f012d760
chore: add supported options to the readme file ( #1899 )
2022-02-04 14:33:43 +02:00
AlexVarchuk
18832b9252
chore: add showObjectSchemaExamples to readme ( #1898 )
2022-02-04 12:25:41 +02:00
Oprysk Vyacheslav
913b3a422f
chore: update docs ( #1825 )
2021-12-09 15:27:31 +02:00
Heather Cloward
6cbd96a24a
[GSoD]Reorganizes the quickstart into a deployment guide and quickstart ( #1749 )
...
* Reorganizes the quickstart into a deployment guide and quickstart
* Minor edits
* fix: minor formatting issue
* fix: simplify phrasing
* Adds redirects, link to preview-docs docs, and other review edits
* remove IE polyfills as IE is no longer supported
Co-authored-by: Ivana Isadora Devcic <33730345+skadinna@users.noreply.github.com>
2021-11-23 16:07:56 +11:00
Roman Hotsiy
262177ddfd
chore: remove broken badges from README
2021-11-08 09:11:44 +02:00
Swapnil Ogale
0f53f4b208
Merge pull request #1748 from HCloward/docs/more-readme-updates
...
[GSoD]Updates readme with about section and organizes features list
2021-10-11 10:37:02 +11:00
Heather Cloward
c4564de324
Updates image src
2021-10-09 14:46:36 -04:00
Heather Cloward
3cc6ea4589
Minor edit
2021-10-09 14:44:37 -04:00
Heather Cloward
1c8578ea88
Adds comparison table and OpenAPI link section
2021-10-09 14:40:39 -04:00
Heather Cloward
8d93021f17
Minor edits
2021-09-22 22:20:49 -04:00
Heather Cloward
86907bd7ae
Merge branch 'docs/more-readme-updates' of github.com:HCloward/redoc into docs/more-readme-updates
2021-09-22 22:17:36 -04:00
Heather Cloward
669adddc9d
Updates per reviews and adds new logo
2021-09-22 22:17:19 -04:00
Ivana Isadora Devcic
c87600d520
fix: Redoc spelling
2021-09-21 22:17:48 +02:00
Mark Theisen
bd9390a5bf
feat: new option generatedPayloadSamplesMaxDepth ( #1642 )
2021-09-14 13:08:50 +03:00
Heather Cloward
899d7f9637
Adds some notes to deployment
2021-09-13 07:22:18 -04:00
Heather Cloward
f8925facf8
Updates readme with about section and organizes features list
2021-09-12 21:41:29 -04:00
Swapnil Ogale
e7f7d963bd
Update README.md
...
Co-authored-by: Adam Altman <adam@rebilly.com>
2021-09-01 22:03:57 +10:00
Ivana Isadora Devcic
a7ed8ddd98
Apply suggestions from code review
2021-09-01 13:48:46 +02:00
Heather Cloward
8afcf1b932
Removes content that is now in documentation and adds link to docs
2021-08-29 21:27:18 -04:00
Marius Butuc
836c422262
docs: add real-life usage example: BoxKnight ( #1651 )
2021-07-30 11:19:41 +03:00
Roman Hotsiy
c09cf9dbbe
chore: modernize build pipeline ( #1635 )
2021-06-09 14:57:36 +03:00
Andriy Leliv
44152fdae7
docs: update specUrl ( #1577 )
2021-04-12 21:26:00 +03:00
Kurt Furbush
e5644ee67a
docs: remove extra word in grammar ( #1539 )
2021-03-31 15:52:45 +03:00
迷渡
4846259de3
docs: minor syntax highlight fix on the README ( #1549 )
2021-03-02 09:35:28 +02:00
