Commit Graph

12 Commits

Author SHA1 Message Date
Shahed Nasser
d1b4b11ff6 chore(docs): added eslint to lint documentation code blocks (#2920)
* docs: added rule for code length

* chore: fixes based on vale errors

* changed to use eslint

* fixes using eslint

* added github action for documentation eslint

* changed allowed max-length

* fixed incorrect heading level

* removed comment
2022-12-30 18:44:46 +02:00
Shahed Nasser
b0ebfd6bcf docs: added dividers + see also section (#2899) 2022-12-26 15:52:08 +02:00
Shahed Nasser
319bcc71b0 docs: updated event reference (#2791)
* docs: updated events reference

* docs: added noCopy metadata option for code blocks
2022-12-13 18:14:53 +02:00
Shahed Nasser
a57177ded5 docs: redesigned code blocks (#2745)
* docs: redesigned code blocks to include titles

* docs: added a title where necessary
2022-12-08 18:52:54 +02:00
Shahed Nasser
c0639ef708 docs: added code blocks without headers (#2560) 2022-11-07 17:36:51 +02:00
Harshavardhan Bajoria
f222b7f1df docs: fixed some typos and grammatical errors (#2337)
* Update README.md

* Update usage.md

* Update contribution-guidelines.md

* Update quick-start-docker.md

* Update OrderService.md

* Update CartService.md

* Update README.md

* Update quick-start-docker.md

* Update usage.md

* Update CartService.md

* Update OrderService.md

* Update contribution-guidelines.md

* Update contribution-guidelines.md

* Update contribution-guidelines.md

* Update contribution-guidelines.md
2022-10-04 12:10:25 +03:00
Shahed Nasser
739d3d3887 docs: added note about base branch (#2278) 2022-09-29 18:30:23 +03:00
Shahed Nasser
6adaf56c73 docs: integrate Vale for documentation linting (#2242)
* added value rules

* resolved errors raised by vale

* added github action

* fixes to github action

* added details in contribution guidelines

* added rule for numbers

* limited checks to errors
2022-09-22 13:12:09 +03:00
Shahed Nasser
5661250049 docs: adjust summary length of endpoints (#2188)
* change titles for admin apis

* adjusted titles for storefront apis

* added a note about length in contribution guidelines

* adjusted title for get customer endpoint
2022-09-12 18:32:26 +03:00
Shahed Nasser
65654c551f docs: adjust font size of sidebar items (#2158)
* adjust font size

* made sidebar narrower
2022-09-07 19:20:51 +03:00
Shahed Nasser
9c2511a86d Added guidelines for sidebar labels 2022-06-16 18:05:44 +03:00
Shahed Nasser
dcbc1e9f5a added docs contribution guidelines 2022-06-16 18:05:44 +03:00