Update overview.mdx #188
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Require Checklist | |
| on: | |
| pull_request: | |
| types: [opened] | |
| branches: | |
| - main | |
| - 'staging' | |
| jobs: | |
| comment: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/github-script@v5 | |
| with: | |
| script: | | |
| github.rest.issues.createComment({ | |
| issue_number: context.issue.number, | |
| owner: context.repo.owner, | |
| repo: context.repo.repo, | |
| body: '# Checklist to merge a PR 🚀 \n \nTo merge this pull request, please take time to complete the checklist.\n \n## What action did you perform? \n \nReview the corresponding checklist items for the action you performed and mark them done. \n \n### Edit an existing content (MDX) page \n \nChecklist \n \n- [ ] Review changes using the <a href="https://github.com/SetuHQ/vscode-docter-preview#mdx-preview" target="_blank">MDX preview</a> option \n- [ ] If the length of content >15000 chars, use the <a href="https://docs.setu.co/content-preview" target="_blank">Content preview portal</a> to view changes \n- [ ] If a redirect is needed to the existing page, add a key, value pair in `redirects.json` \n \n<hr /> \n \n### Edit an existing API reference page \n \nChecklist \n \n- [ ] Use the <a href="https://docs.setu.co/content-preview" target="_blank">Content preview portal</a> to view changes \n- [ ] API reference is in JSON format (OpenAPI or Swagger) \n \n<hr /> \n \n### Add a new content (MDX) page \n \nChecklist \n \n- [ ] Create a `.mdx` file with the path as its name in the content folder \n- [ ] Add frontmatter with all the metadata \n- [ ] Review the order of items in Sidebar using the <a href="https://github.com/SetuHQ/vscode-docter-preview#sidebar-preview" target="_blank">Sidebar preview</a> option \n- [ ] Review changes using the <a href="https://github.com/SetuHQ/vscode-docter-preview#mdx-preview" target="_blank">MDX preview</a> option \n- [ ] If the length of content >15000 chars, use the <a href="https://docs.setu.co/content-preview" target="_blank">Content preview portal</a> to view changes \n- [ ] Created a folder with the same name, if any children were to be added to the page \n- [ ] Once all changes are done, update the menu items by using the <a href="https://github.com/SetuHQ/vscode-docter-preview#menu-items" target="_blank">Menu Items</a> option \n- [ ] Add a key, and value pair in `redirects.json` if you wish to have a redirect to the new page \n \n<hr /> \n \n### Add a new API reference page \n \nChecklist \n \n- [ ] Create a `.json` file with the product path as its name \n- [ ] Create an `api-reference.mdx` file in the respective product folder inside content folder \n- [ ] Add frontmatter with all the metadata \n- [ ] Review the order of items in Sidebar using the <a href="https://github.com/SetuHQ/vscode-docter-preview#sidebar-preview" target="_blank">Sidebar preview</a> option \n- [ ] Add API reference in JSON format (OpenAPI or Swagger) into created `.json` file. \n- [ ] Used the <a href="https://docs.setu.co/content-preview" target="_blank">Content preview portal</a> to view changes \n- [ ] Once all changes are done, update the menu items by using the <a href="https://github.com/SetuHQ/vscode-docter-preview#menu-items" target="_blank">Menu Items</a> option \n' | |
| }) |