Skip to content

Conversation

@jake-mahon
Copy link
Contributor

Wrap {TenantName} placeholders in backticks to prevent Docusaurus from interpreting them as JavaScript expressions, which was causing build failures.

Changed 6 occurrences across 2 table rows (ports 80 and 443).

Wrap {TenantName} placeholders in backticks to prevent Docusaurus from interpreting them as JavaScript expressions, which was causing build failures.

Changed 6 occurrences across 2 table rows (ports 80 and 443).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
@jake-mahon jake-mahon requested a review from a team as a code owner October 27, 2025 14:59
@claude
Copy link

claude bot commented Oct 27, 2025

PR Review - Fix curly braces in SharePoint Online ports documentation

Summary

This PR addresses a critical build issue by wrapping {TenantName} placeholders in backticks to prevent Docusaurus from interpreting them as JavaScript expressions. The fix is correct and necessary.


✅ Code Quality & Best Practices

Strengths:

  • Correct fix: Wrapping placeholders in backticks is the standard Docusaurus/MDX solution for preventing JSX interpolation
  • Consistent change: All 6 occurrences of {TenantName} in the affected rows are properly fixed
  • Clear commit message: Well-documented with rationale and Claude Code attribution
  • Minimal scope: Only changes what's necessary (2 additions, 2 deletions)

Documentation standard compliance:

  • Follows Markdown best practices for technical documentation
  • Aligns with Docusaurus MDX requirements for escaping curly braces
  • Consistent with similar patterns found across the codebase (55+ files use backtick-wrapped placeholders)

🔍 Potential Issues & Considerations

Consistency check - similar patterns found:
I found 3 files in the codebase with TenantName placeholders:

  1. docs/auditor/10.8/configuration/microsoft365/sharepointonline/ports.md (fixed in this PR)
  2. ⚠️ docs/auditor/10.8/configuration/azurefiles/overview.md - Line 108 has TenantName in plain text ("Grant admin consent for TenantName") - but this appears to be in prose, not a code placeholder
  3. docs/accessanalyzer/12.0/solutions/filesystem/collection/fs_azuretenantscan.md - Should be checked for similar issues

Recommendation: Consider auditing other markdown files that use curly braces without backticks to prevent future build failures. I found several patterns like {0} in logging examples that may need attention if they cause similar issues.


🚀 Performance Considerations

  • No performance impact: This is a documentation fix only
  • Build improvement: Resolves build failures, enabling successful deployments
  • No runtime changes: Purely a content fix

🔒 Security Concerns

  • No security issues identified
  • The change is cosmetic/syntax-related only
  • Placeholder text remains clearly identifiable to users

🧪 Test Coverage

Manual testing recommended:

  1. ✅ Verify the build completes successfully (original issue was build failure)
  2. ✅ Check that the rendered documentation displays {TenantName} correctly in the browser
  3. ✅ Confirm the table formatting remains intact

Build verification:
Since this was causing build failures, confirming the build passes is the primary test requirement.


📋 Recommendations

  1. Approve and merge - This fix is correct and necessary

  2. Consider follow-up PR: Search for other instances of unescaped curly braces in markdown that might cause similar build issues:

    • Pattern to search: {[A-Za-z]+} not wrapped in backticks
    • Found 55+ files already using backtick pattern correctly
    • May want to standardize any remaining instances
  3. Documentation note: Consider adding a note to the README or contributing guidelines about escaping curly braces in MDX/Docusaurus markdown files


✅ Final Verdict

APPROVED - This is a well-executed fix that:

  • Solves the immediate build failure
  • Uses the correct Docusaurus/MDX syntax
  • Maintains documentation clarity
  • Has minimal scope and risk

Great work fixing this build blocker! 🎉

@jake-mahon
Copy link
Contributor Author

@TheNewCat777 this PR should fix a markdown syntax error that has been preventing dev builds - let me know if you can review, thanks :)

@jake-mahon jake-mahon merged commit fc1a47e into dev Oct 27, 2025
5 checks passed
@jake-mahon jake-mahon deleted the fix-sharepointonline-curly-braces branch October 27, 2025 16:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants