docs: fix typos, code syntax issues, and improve Prisma AIRS documentation#1012
Open
scthornton wants to merge 5 commits intoPaloAltoNetworks:masterfrom
Open
docs: fix typos, code syntax issues, and improve Prisma AIRS documentation#1012scthornton wants to merge 5 commits intoPaloAltoNetworks:masterfrom
scthornton wants to merge 5 commits intoPaloAltoNetworks:masterfrom
Conversation
- Fix spelling: "prerequsities" → "prerequisites" in usecases.md - Fix spelling: "adminstration" → "administration" in airuntimesecurityapi.md - Fix spelling: "intecept" → "intercept" in airuntimesecurityapi.md - Fix security issue: HTTP → HTTPS for Strata Cloud Manager login URL - Fix grammar: add missing "to" in Custom Topics bullet point These corrections improve documentation quality and fix a security concern where the Strata Cloud Manager login link used HTTP instead of HTTPS.
Fixed several issues found while reviewing the Prisma AIRS documentation: Spelling corrections: - "Synchrounous" → "Synchronous" in errorcodes.md - "Asycio" → "Asyncio" in pythonsdkasynciousage.md heading - "storty" → "story" in code example - "structur" → "structure" in incomplete comment - "Asyncronous" → "Asynchronous" in pythonsdkusage.md Python code fixes: - Remove incorrect 'await' keyword in synchronous scanner.close() calls (pythonsdkusage.md lines 58, 183, 221, 331) - These examples are synchronous, so await causes SyntaxError Documentation clarity: - Fix circular reference: "Review the scan API endpoints in the scan API endpoints" now links to actual endpoints section - Add missing closing quote in curl command (usecases.md line 122) - Remove Python-style # comments from JSON examples (invalid JSON syntax) Terminology consistency: - Standardize "AI Network" → "AI Runtime" in errorcodes.md - Fix markdown lint: wrap bare URLs in angle brackets
scthornton
changed the title
sarette
reviewed
Oct 17, 2025
Collaborator
There was a problem hiding this comment.
You have several places in this file where the edit changed 'structure' to 'structuree'. Please fix this.
- Fix spelling: "structuree" → "structure" in pythonsdkasynciousage.md (appears in two code comment locations)
sarette
approved these changes
Oct 19, 2025
|
Visit the preview URL for this PR (updated for commit 8f24c5f): https://pan-dev-f1b58--pr1012-456e83yl.web.app (expires Tue, 18 Nov 2025 03:51:37 GMT) 🔥 via Firebase Hosting GitHub Action 🌎 Sign: 9359a9fa100d5fdb082f75280473a90b1f96eb51 |
Add standard documentation for Docusaurus developer platform: - Enhanced .gitignore with AI artifact patterns - CHANGELOG.md documenting platform features and technical stack - SECURITY.md with site security, reporting channels, and best practices
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR improves the Prisma AIRS documentation quality through typo corrections, code syntax fixes, and consistency improvements.
Changes Made
Commit 1: Initial Documentation Fixes
Spelling Corrections:
Security Fix:
4. airuntimesecurityapi.md (line 53): Changed Strata Cloud Manager login URL from HTTP to HTTPS
http://stratacloudmanager.paloaltonetworks.com/https://stratacloudmanager.paloaltonetworks.com/Grammar Fix:
5. airuntimesecurityapi.md (line 59): Added missing word "to" in Custom Topics bullet
Commit 2: Code Syntax and Additional Documentation Fixes
Additional Spelling Corrections:
Critical Python Code Fixes:
awaitkeyword in synchronousscanner.close()callsawaitoutside async function causes SyntaxErrorawait scanner.close()toscanner.close()Documentation Clarity:
#comments from JSON examples (JSON doesn't support comments)Consistency Improvements:
Files Modified
products/prisma-airs/api/airuntimesecurity/airuntimesecurityapi.mdproducts/prisma-airs/api/airuntimesecurity/usecases.mdproducts/prisma-airs/api/airuntimesecurity/errorcodes.mdproducts/prisma-airs/api/airuntimesecurity/pythonsdkusage.mdproducts/prisma-airs/api/airuntimesecurity/pythonsdkasynciousage.mdTesting
All changes are documentation-only and improve quality, security, and code accuracy.