Title: Improve clarity of intro paragraph on REST API Guides page Body: The intro paragraph on /rest/guides reuses the word "results" with two different meanings in the same sentence, making it harder to read. Proposing a small copy edit for clarity. #14555
Workflow file for this run
This file contains hidden or 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: 'Content Lint Markdown' | |
| # **What it does**: Lints our content markdown to ensure the content matches the specified styleguide. | |
| # **Why we have it**: We want some level of consistency to our content markdown files. | |
| # **Who does it impact**: Docs content writers. | |
| on: | |
| pull_request: | |
| merge_group: | |
| workflow_dispatch: | |
| inputs: | |
| branch: | |
| description: The branch containing the changes we want to lint. | |
| required: true | |
| type: string | |
| default: main | |
| permissions: | |
| contents: read | |
| jobs: | |
| lint-content: | |
| if: github.repository == 'github/docs-internal' || github.repository == 'github/docs' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Check out repo | |
| uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0 | |
| with: | |
| # Fetch 2 commits so tj-actions/changed-files can diff without extra API calls | |
| fetch-depth: 2 | |
| - name: Set up Node and dependencies | |
| uses: ./.github/actions/node-npm-setup | |
| - name: Get changed content/data files | |
| id: changed_files | |
| uses: tj-actions/changed-files@22103cc46bda19c2b464ffe86db46df6922fd323 # v47.0.5 | |
| with: | |
| files: | | |
| content/** | |
| data/** | |
| - name: Print content linter annotations if changed content/data files | |
| if: steps.changed_files.outputs.any_modified == 'true' | |
| env: | |
| CHANGED_FILES: ${{ steps.changed_files.outputs.all_modified_files }} | |
| # If there are errors, using `--print-annotations` will make it | |
| # so it does *not* exit non-zero. | |
| # This is so that all warnings and errors are printed. | |
| run: npm run lint-content -- --print-annotations --paths $CHANGED_FILES | |
| - name: Run content linter if changed content/data files | |
| if: steps.changed_files.outputs.any_modified == 'true' | |
| env: | |
| CHANGED_FILES: ${{ steps.changed_files.outputs.all_modified_files }} | |
| run: npm run lint-content -- --errors-only --paths $CHANGED_FILES |