Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ADAPP-18865 rework Reports Service API docs #1155

Open
wants to merge 14 commits into
base: main
Choose a base branch
from

fix: update lycheeignore list

b389759
Select commit
Loading
Failed to load commit list.
Sign in for the full log view
Open

ADAPP-18865 rework Reports Service API docs #1155

fix: update lycheeignore list
b389759
Select commit
Loading
Failed to load commit list.
GitHub Actions / vale completed Nov 21, 2024 in 1s

reviewdog [vale] report

reported by reviewdog 🐶

Findings (3)

src/content/docs/en/api/_authentication.mdoc|11 col 17| [Microsoft.FirstPerson] Use first person (such as 'My') sparingly.
src/content/docs/en/api/_authentication.mdoc|22 col 17| [Microsoft.FirstPerson] Use first person (such as 'My') sparingly.
src/content/docs/en/api/reports-service.mdoc|347 col 13| [Microsoft.HeadingAcronyms] Avoid using acronyms in a title or heading.

Filtered Findings (75)

src/content/docs/en/api/blocklist.mdx|27 col 17| [Microsoft.FirstPerson] Use first person (such as 'My') sparingly.
src/content/docs/en/api/blocklist.mdx|38 col 17| [Microsoft.FirstPerson] Use first person (such as 'My') sparingly.
src/content/docs/en/api/device-api.mdx|29 col 17| [Microsoft.FirstPerson] Use first person (such as 'My') sparingly.
src/content/docs/en/api/device-api.mdx|40 col 17| [Microsoft.FirstPerson] Use first person (such as 'My') sparingly.
src/content/docs/en/api/deep-link-generator-api.mdx|50 col 17| [Microsoft.FirstPerson] Use first person (such as 'My') sparingly.
src/content/docs/en/api/deep-link-generator-api.mdx|61 col 17| [Microsoft.FirstPerson] Use first person (such as 'My') sparingly.
src/content/docs/en/api/campaign-api.mdx|21 col 17| [Microsoft.FirstPerson] Use first person (such as 'My') sparingly.
src/content/docs/en/api/campaign-api.mdx|32 col 17| [Microsoft.FirstPerson] Use first person (such as 'My') sparingly.
src/content/docs/en/api/ad-spend-api.mdx|81 col 22| [Microsoft.Adverbs] Remove 'properly' if it's not important to the meaning of the statement.
src/content/docs/en/api/s2s-api/security.mdx|139 col 32| [Microsoft.FirstPerson] Use first person (such as 'My') sparingly.
src/content/docs/en/api/s2s-api/attribution-checklist.mdx|61 col 103| [Microsoft.Hyphens] 'universally-unique' doesn't need a hyphen.
src/content/docs/en/api/app-automation-api/authentication.mdx|25 col 17| [Microsoft.FirstPerson] Use first person (such as 'My') sparingly.
src/content/docs/en/api/app-automation-api/authentication.mdx|34 col 17| [Microsoft.FirstPerson] Use first person (such as 'My') sparingly.
src/content/docs/en/sdk/cordova/v4/configuration.mdx|43 col 30| [Microsoft.Hyphens] 'readonly-configuration' doesn't need a hyphen.
src/content/docs/en/sdk/cordova/v5/configuration.mdx|43 col 30| [Microsoft.Hyphens] 'readonly-configuration' doesn't need a hyphen.
src/content/docs/en/sdk/cocos2dx/v5/features/purchase-verification.mdoc|129 col 29| [Microsoft.Hyphens] 'only-verify' doesn't need a hyphen.
src/content/docs/en/sdk/cocos2dx/v5/features/purchase-verification.mdoc|133 col 39| [Microsoft.Hyphens] 'only-verify' doesn't need a hyphen.
src/content/docs/en/sdk/cocos2dx/v5/features/purchase-verification.mdoc|170 col 41| [Microsoft.Hyphens] 'only-verify' doesn't need a hyphen.
src/content/docs/en/sdk/cocos2dx/v5/configuration.mdoc|56 col 37| [Microsoft.Hyphens] 'only-configuration' doesn't need a hyphen.
src/content/docs/en/sdk/ios/v4/features/deep-links/direct.mdx|53 col 70| [Microsoft.Contractions] Use 'don't' instead of 'do not'.
src/content/docs/en/sdk/ios/v4/configuration.mdx|75 col 35| [Microsoft.Hyphens] 'only-configuration' doesn't need a hyphen.
src/content/docs/en/sdk/ios/v5/features/purchase-verification.mdx|102 col 27| [Microsoft.Hyphens] 'only-verify' doesn't need a hyphen.
src/content/docs/en/sdk/ios/v5/features/privacy.mdx|667 col 23| [Microsoft.HeadingAcronyms] Avoid using acronyms in a title or heading.
src/content/docs/en/sdk/ios/v5/features/deep-links/direct.mdx|53 col 70| [Microsoft.Contractions] Use 'don't' instead of 'do not'.
src/content/docs/en/sdk/ios/v5/configuration.mdx|86 col 35| [Microsoft.Hyphens] 'only-configuration' doesn't need a hyphen.
src/content/docs/en/sdk/android/v4/features/uninstall-reinstall.mdx|35 col 19| [Microsoft.HeadingAcronyms] Avoid using acronyms in a title or heading.
src/content/docs/en/sdk/android/v4/features/uninstall-reinstall.mdx|41 col 108| [Microsoft.Terms] Prefer 'cloud' over 'the Cloud'.
src/content/docs/en/sdk/android/v4/features/deep-linking.mdx|28 col 331| [Microsoft.We] Try to avoid using first-person plural like 'our'.
src/content/docs/en/sdk/android/v4/features/deep-linking.mdx|28 col 374| [Microsoft.Contractions] Use 'can't' instead of 'cannot'.
src/content/docs/en/sdk/android/v4/plugins/imei-plugin.mdx|27 col 8| [Microsoft.HeadingAcronyms] Avoid using acronyms in a title or heading.
src/content/docs/en/sdk/android/v4/configuration.mdx|70 col 35| [Microsoft.Hyphens] 'only-configuration' doesn't need a hyphen.
src/content/docs/en/sdk/android/v5/features/purchase-verification.mdx|106 col 27| [Microsoft.Hyphens] 'only-verify' doesn't need a hyphen.
src/content/docs/en/sdk/android/v5/features/uninstall-reinstall.mdx|35 col 19| [Microsoft.HeadingAcronyms] Avoid using acronyms in a title or heading.
src/content/docs/en/sdk/android/v5/features/uninstall-reinstall.mdx|41 col 108| [Microsoft.Terms] Prefer 'cloud' over 'the Cloud'.
src/content/docs/en/sdk/android/v5/features/deep-linking.mdx|28 col 331| [Microsoft.We] Try to avoid using first-person plural like 'our'.
src/content/docs/en/sdk/android/v5/features/deep-linking.mdx|28 col 374| [Microsoft.Contractions] Use 'can't' instead of 'cannot'.
src/content/docs/en/sdk/android/v5/plugins/imei-plugin.mdx|27 col 8| [Microsoft.HeadingAcronyms] Avoid using acronyms in a title or heading.
src/content/docs/en/sdk/android/v5/configuration.mdx|60 col 35| [Microsoft.Hyphens] 'only-configuration' doesn't need a hyphen.
src/content/docs/en/sdk/web/features/device-info.mdx|9 col 8| [Microsoft.HeadingAcronyms] Avoid using acronyms in a title or heading.
src/content/docs/en/sdk/windows/index.mdx|20 col 34| [Microsoft.Ellipses] In general, don't use an ellipsis.
src/content/docs/en/sdk/flutter/v4/features/purchase-verification.mdx|110 col 27| [Microsoft.Hyphens] 'only-verify' doesn't need a hyphen.
src/content/docs/en/sdk/windows/configuration.mdx|48 col 35| [Microsoft.Hyphens] 'only-configuration' doesn't need a hyphen.
src/content/docs/en/sdk/flutter/v5/features/purchase-verification.mdx|110 col 27| [Microsoft.Hyphens] 'only-verify' doesn't need a hyphen.
src/content/docs/en/sdk/flutter/v4/configuration.mdx|45 col 35| [Microsoft.Hyphens] 'only-configuration' doesn't need a hyphen.
src/content/docs/en/sdk/flutter/v5/configuration.mdx|41 col 35| [Microsoft.Hyphens] 'only-configuration' doesn't need a hyphen.
src/content/docs/en/sdk/migration/ios/web-v4-to-v5.mdx|56 col 13| [Microsoft.HeadingAcronyms] Avoid using acronyms in a title or heading.
src/content/docs/en/sdk/migration/ios/web-v4-to-v5.mdx|439 col 17| [Microsoft.Terms] Prefer 'personal digital assistant' over 'agent'.
src/content/docs/en/sdk/migration/ios/v5-purchase-verification.mdx|125 col 29| [Microsoft.Hyphens] 'only-verify' doesn't need a hyphen.
src/content/docs/en/sdk/migration/cocos2dx/v4-to-v5.mdoc|202 col 13| [Microsoft.HeadingAcronyms] Avoid using acronyms in a title or heading.
src/content/docs/en/sdk/migration/cocos2dx/v4-to-v5.mdoc|674 col 17| [Microsoft.Terms] Prefer 'personal digital assistant' over 'agent'.
src/content/docs/en/sdk/migration/ios/v4-to-v5.mdx|244 col 13| [Microsoft.HeadingAcronyms] Avoid using acronyms in a title or heading.
src/content/docs/en/sdk/migration/ios/v4-to-v5.mdx|1491 col 17| [Microsoft.Terms] Prefer 'personal digital assistant' over 'agent'.
src/content/docs/en/sdk/migration/cordova/v4-to-v5.mdx|124 col 13| [Microsoft.HeadingAcronyms] Avoid using acronyms in a title or heading.
src/content/docs/en/sdk/migration/cordova/v4-to-v5.mdx|770 col 17| [Microsoft.Terms] Prefer 'personal digital assistant' over 'agent'.
src/content/docs/en/sdk/migration/cordova/v4-to-v5.mdx|772 col 70| [Microsoft.Terms] Prefer 'personal digital assistant' over 'agent'.
src/content/docs/en/sdk/migration/android/web-v4-to-v5.mdx|148 col 49| [Microsoft.Hyphens] 'only-once' doesn't need a hyphen.
src/content/docs/en/sdk/migration/android/web-v4-to-v5.mdx|442 col 17| [Microsoft.Terms] Prefer 'personal digital assistant' over 'agent'.
src/content/docs/en/sdk/migration/android/v5-purchase-verification.mdx|130 col 29| [Microsoft.Hyphens] 'only-verify' doesn't need a hyphen.
src/content/docs/en/sdk/migration/unity/v5-purchase-verification.mdx|145 col 29| [Microsoft.Hyphens] 'only-verify' doesn't need a hyphen.
src/content/docs/en/sdk/migration/android/v4-to-v5.mdx|1146 col 17| [Microsoft.Terms] Prefer 'personal digital assistant' over 'agent'.
src/content/docs/en/sdk/migration/flutter/v4-to-v5.mdx|111 col 13| [Microsoft.HeadingAcronyms] Avoid using acronyms in a title or heading.
src/content/docs/en/sdk/migration/flutter/v4-to-v5.mdx|622 col 17| [Microsoft.Terms] Prefer 'personal digital assistant' over 'agent'.
src/content/docs/en/sdk/migration/flutter/v4-to-v5.mdx|624 col 72| [Microsoft.Terms] Prefer 'personal digital assistant' over 'agent'.
src/content/docs/en/sdk/migration/react-native/v4-to-v5.mdx|118 col 13| [Microsoft.HeadingAcronyms] Avoid using acronyms in a title or heading.
src/content/docs/en/sdk/migration/react-native/v4-to-v5.mdx|723 col 17| [Microsoft.Terms] Prefer 'personal digital assistant' over 'agent'.
src/content/docs/en/sdk/migration/react-native/v4-to-v5.mdx|725 col 70| [Microsoft.Terms] Prefer 'personal digital assistant' over 'agent'.
src/content/docs/en/sdk/migration/unity/v4-to-v5.mdx|111 col 15| [Microsoft.Spacing] 't.D' should have one space.
src/content/docs/en/sdk/migration/unity/v4-to-v5.mdx|213 col 13| [Microsoft.HeadingAcronyms] Avoid using acronyms in a title or heading.
src/content/docs/en/sdk/migration/unity/v4-to-v5.mdx|998 col 17| [Microsoft.Terms] Prefer 'personal digital assistant' over 'agent'.
src/content/docs/en/sdk/unity/v4/configuration.mdx|42 col 35| [Microsoft.Hyphens] 'only-configuration' doesn't need a hyphen.
src/content/docs/en/sdk/unity/v5/features/purchase-verification.mdx|112 col 27| [Microsoft.Hyphens] 'only-verify' doesn't need a hyphen.
src/content/docs/en/sdk/unity/v5/configuration.mdx|42 col 35| [Microsoft.Hyphens] 'only-configuration' doesn't need a hyphen.
src/content/docs/en/sdk/react-native/v4/configuration.mdx|44 col 35| [Microsoft.Hyphens] 'only-configuration' doesn't need a hyphen.
src/content/docs/en/sdk/react-native/v5/features/purchase-verification.mdx|110 col 27| [Microsoft.Hyphens] 'only-verify' doesn't need a hyphen.
src/content/docs/en/sdk/react-native/v5/configuration.mdx|43 col 35| [Microsoft.Hyphens] 'only-configuration' doesn't need a hyphen.

Annotations

Check warning on line 11 in src/content/docs/en/api/_authentication.mdoc

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] src/content/docs/en/api/_authentication.mdoc#L11

[Microsoft.FirstPerson] Use first person (such as 'My') sparingly.
Raw output
{"message": "[Microsoft.FirstPerson] Use first person (such as 'My') sparingly.", "location": {"path": "src/content/docs/en/api/_authentication.mdoc", "range": {"start": {"line": 11, "column": 17}}}, "severity": "WARNING"}

Check warning on line 22 in src/content/docs/en/api/_authentication.mdoc

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] src/content/docs/en/api/_authentication.mdoc#L22

[Microsoft.FirstPerson] Use first person (such as 'My') sparingly.
Raw output
{"message": "[Microsoft.FirstPerson] Use first person (such as 'My') sparingly.", "location": {"path": "src/content/docs/en/api/_authentication.mdoc", "range": {"start": {"line": 22, "column": 17}}}, "severity": "WARNING"}

Check warning on line 347 in src/content/docs/en/api/reports-service.mdoc

See this annotation in the file changed.

@github-actions github-actions / vale

[vale] src/content/docs/en/api/reports-service.mdoc#L347

[Microsoft.HeadingAcronyms] Avoid using acronyms in a title or heading.
Raw output
{"message": "[Microsoft.HeadingAcronyms] Avoid using acronyms in a title or heading.", "location": {"path": "src/content/docs/en/api/reports-service.mdoc", "range": {"start": {"line": 347, "column": 13}}}, "severity": "WARNING"}