Commit Graph

17 Commits

Author SHA1 Message Date
romana-la
875dfa8d8b docs: replace relative links leading outside of the directory (#1515)
Co-authored-by: Lorna Jane Mitchell <github@lornajane.net>
2024-05-08 11:15:57 +01:00
Lorna Jane Mitchell
fd79f7d4c5 docs: Use Museum API instead of Petstore examples (#1386)
* docs: add museum examples to installation and bundle/join commands

* docs: removed petstore examples and updated formatting for readability

* docs: Update petstore to museum examples in decorators section

* chore: Prettier wants to fix a file

* chore: Fix Vale-detected future tense mistakes

* Update docs/decorators/media-type-examples-override.md

* Update docs/commands/lint.md

* Update docs/commands/lint.md

---------

Co-authored-by: Heather Cloward <heathercloward@gmail.com>
2024-02-12 18:06:11 +00:00
Lorna Jane Mitchell
cddec3327f Docs: Add examples for the filter decorators (#1360)
* docs: Add an example for filter out decorator

* docs: Add a filter-in example

* Chore: run prettier
2023-12-15 10:59:34 +00:00
Lorna Jane Mitchell
de80612b55 chore: Run prettier on all docs files (#1334) 2023-11-17 09:45:03 +00:00
Lorna Jane Mitchell
2ad0ffb0c2 docs: decorators in main sidebar (#1324) 2023-11-10 16:02:28 +00:00
redocly-bot
d008291a32 sync: Synced local 'docs/' with remote 'docs/cli/' 2023-11-09 15:56:27 +00:00
Adam Altman
0a73f1f557 refactor: rename to API description for consistency (#1239) 2023-09-18 15:22:26 +02:00
Lorna Jane Mitchell
909fb471ca Add Vale for prose linting (#1099)
* feat: Add Vale configuration and rules

* docs: Fix top-level files to match Vale rules

* docs: Vale updates for the commands docs

* docs: apply Vale updates to the decorator docs

* docs: Update guides to match Vale rules

* docs: update rules and other content to meet Vale standards

* docs: add Vale link and information to CONTRIBUTING

* feat: Add GitHub action for Vale

* docs: minor editing to readme.md

* docs: minor editing to the changelog.md file

* docs: minor edits to the join.md file in commands folder

* docs: minor edits to lint.md file in the commands directory

* docs: minor edit to the login.md file in the commands directory

* docs: minor edits to the preview.md file in the commands directory

* docs: minor edits to push.md file in the comands directory

* docs: minor edits to the info-description-override.md file in the decorators directory

* docs: minor edits to the configure-rules.md file in the guides directory

* docs: minor edits to custom-plugin.md file in the resources directory

* docs: minor editing to the no-http-verbs-in-paths.md file in the rules directory

---------

Co-authored-by: Heather Cloward <heathercloward@gmail.com>
2023-06-01 10:10:43 +01:00
Lorna Jane Mitchell
db5430515e fix: decorator name in a docs example (#1037) 2023-03-30 12:02:05 +01:00
Roman Hotsiy
f99cf0cf16 feat: new decorator info-override (#999) 2023-01-25 19:18:11 +08:00
redocly-bot
33502fb2ee sync: Synced local 'docs/' with remote 'docs/cli/' 2023-01-08 17:08:09 +00:00
Ihor Karpiuk
7cd5c34d54 feat: add media type examples override decorator (#897) 2022-12-23 16:21:06 +02:00
Andrew Tatomyr
2401c2ef89 chore: rename master to main (#870) 2022-09-14 14:56:21 +02:00
redocly-bot
e0c57206f3 sync: Synced local 'docs/' with remote 'docs/cli/' 2022-09-13 17:43:59 +00:00
Andrew Tatomyr
504cf32a39 docs: rename "lint" to "styleguide" in Redocly config (#791) 2022-08-11 10:01:27 +02:00
redocly-bot
c22bf08b1a sync: Synced local 'docs/' with remote 'docs/cli/' 2022-08-03 20:03:58 +00:00
redocly-bot
a73c884b2c sync: Synced local 'docs/' with remote 'docs/cli/' 2022-08-03 12:21:37 +00:00