Skip to content

docs: remove content#199

Merged
robmorgan merged 3 commits into
mainfrom
docs/remove-commercial-content
Dec 30, 2025
Merged

docs: remove content#199
robmorgan merged 3 commits into
mainfrom
docs/remove-commercial-content

Conversation

@robmorgan

Copy link
Copy Markdown
Owner

Summary

  • Move virtual-cloud.mdx to docs section and rewrite with open source tone, emphasizing the free built-in emulator
  • Remove commercial pages: pricing, early-access, vs-localstack
  • Move cloudmirror documentation under virtual-cloud section
  • Remove early access link from header navigation
  • Simplify GetStartedModal to show only CLI installation (removed InfraSpec Cloud section)
  • Update navigation metadata for new page structure

Changes

Change Description
website/src/content/docs/virtual-cloud/ New section for Virtual Cloud documentation
website/src/content/docs/virtual-cloud/overview.mdx Rewrites virtual cloud as free, built-in emulator
website/src/content/docs/virtual-cloud/cloudmirror.mdx Moved from root docs
Deleted pages pricing.mdx, early-access.mdx, vs-localstack.mdx
layout.jsx Removed early access nav link
GetStartedModal.tsx Removed InfraSpec Cloud section

Test plan

  • Run npm run dev in website directory to verify pages render correctly
  • Verify navigation works and new virtual-cloud section is accessible
  • Confirm removed pages return 404s
  • Check GetStartedModal opens with simplified layout

🤖 Generated with Claude Code

- Move virtual-cloud.mdx to docs section and rewrite with open source tone
- Remove pricing, early-access, vs-localstack, and cloudmirror pages
- Remove early access link from header navigation
- Simplify GetStartedModal to show only CLI installation
- Update navigation metadata for new page structure

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

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@vercel

vercel Bot commented Dec 30, 2025

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Review Updated (UTC)
infraspec Ready Ready Preview, Comment Dec 30, 2025 6:20am

@claude

claude Bot commented Dec 30, 2025

Copy link
Copy Markdown
Contributor

Pull Request Review

This PR successfully repositions InfraSpec as an open-source infrastructure testing tool with a built-in emulator, removing commercial content and early access marketing.

Strengths

  1. Clear Documentation Improvements - The new virtual-cloud/overview.mdx is comprehensive with excellent LocalStack comparison
  2. Consistent Navigation Updates - Properly moved CloudMirror docs under virtual-cloud section
  3. Component Simplification - GetStartedModal.tsx correctly simplified to focus on CLI installation

Critical Issues Found

  1. Lines 28, 35, 108 in virtual-cloud/overview.mdx contain whitespace artifacts that should be removed
  2. Line 111 GitLab CI YAML is malformed - all on one line instead of properly indented
  3. Line 196 references /docs/guides/live-testing which may not exist
  4. Line 120 uses cimg/go:1.21 but should use 1.24 per CLAUDE.md requirements
  5. Line 145 CloudMirror link needs update from /docs/cloudmirror to /docs/virtual-cloud/cloudmirror

Suggestions

  1. Consider keeping simplified service matrix in roadmap
  2. Improve meta file quote consistency in _meta.js

Security Review

No security concerns identified - no credentials exposed, HTTPS used appropriately.

Code Quality

Lines: +214/-1,156 (net -942), Files: 12, Conventional commits: Yes

Overall Quality: Good - needs minor formatting fixes before merge.

Recommendation

Request Changes - fix the 5 critical issues above, then this will be ready to merge.

@claude

claude Bot commented Dec 30, 2025

Copy link
Copy Markdown
Contributor

PR Review: Documentation Refactoring for Open Source Positioning

This PR successfully repositions InfraSpec as an open-source project by removing commercial content and emphasizing the free, built-in Virtual Cloud emulator. The changes are well-aligned with the project's goals and improve clarity for users.

✅ Strengths

1. Clear Messaging Transformation

  • Excellent shift from commercial to open-source positioning
  • The new homepage and Virtual Cloud overview clearly communicate value without commercial pressure
  • Removes confusion between open-source tool and paid service

2. Content Quality

  • The new virtual-cloud/overview.mdx is comprehensive and well-structured
  • Good balance of benefits, practical examples, and FAQ
  • LocalStack comparison table is fair and objective
  • CI/CD integration examples are practical and cover major platforms

3. Code Quality

  • Clean removal of 1174 lines while adding focused content
  • Proper file reorganization (cloudmirror moved to virtual-cloud subsection)
  • GetStartedModal simplification improves UX by focusing on single path

4. Follows Project Standards

  • Commit message follows Conventional Commits format: docs: remove commercial content and reposition as open source
  • Good use of scope (docs:)
  • Changes are well-documented in PR description

🐛 Issues Found

1. CRITICAL: Broken YAML Formatting in GitLab CI Example

website/src/content/docs/virtual-cloud/overview.mdx:111-112

The GitLab CI code block is malformed:

# Current (broken):
  ```yaml filename=".gitlab-ci.yml" test: image: golang:1.24 script: - curl -fsSL https://infraspec.sh/install.sh | bash
  - infraspec features/ ```

# Should be:
  ```yaml filename=".gitlab-ci.yml"
  test:
    image: golang:1.24
    script:
      - curl -fsSL https://infraspec.sh/install.sh | bash
      - infraspec features/

This will likely cause rendering issues and confuse users copying the example.

**2. Grammar Issue in Roadmap**

`website/src/content/docs/roadmap.mdx:4`

```markdown
# Current:
InfraSpec is evolving rapidly, with support for major AWS products and services. Below you'll find a high-level roadmap, of the planned features.

# Suggested:
InfraSpec is evolving rapidly, with support for major AWS products and services. Below you'll find a high-level roadmap of the planned features.

Remove the comma before "of" - it creates an awkward pause.

3. Minor: Inconsistent Link Reference

website/src/content/docs/virtual-cloud/overview.mdx:145

The CloudMirror link uses /docs/cloudmirror but the file is now at /docs/virtual-cloud/cloudmirror. While Nextra may handle this, it's better to use relative links or the correct path:

# Current:
Weekly via [CloudMirror](/docs/cloudmirror)

# Better:
Weekly via [CloudMirror](/docs/virtual-cloud/cloudmirror)

Same issue on line 185.

💡 Suggestions

1. Missing Installation Script Validation

The PR introduces https://infraspec.sh/install.sh in multiple places. Ensure:

  • The script exists at this URL
  • It's secure and maintained
  • Consider adding a note about reviewing install scripts before piping to bash

2. Consider Adding Metadata

The new virtual-cloud/overview.mdx file doesn't have frontmatter metadata like title or description. While optional, it helps with SEO:

---
title: Virtual Cloud Emulator
description: Test your infrastructure code with InfraSpec's built-in AWS emulator - fast, free, and zero setup required.
---

3. Test Coverage Consideration

The PR description mentions a test plan but doesn't indicate completion. Consider:

  • Running npm run dev to verify rendering
  • Checking that removed pages return 404s
  • Testing the simplified GetStartedModal

🔐 Security

No security concerns identified:

  • Removal of credential requirements improves security posture
  • No sensitive data exposed
  • External links are appropriate

📊 Performance

  • Excellent: Removed 1174 lines while adding only 232, reducing bundle size
  • Simplified modal component reduces React tree complexity
  • No performance regressions expected

🎯 Overall Assessment

This is a well-executed refactoring that successfully achieves its goals. The critical YAML formatting issue should be fixed before merging, but otherwise the changes are solid.

Recommendation: Approve with required changes

Fix the GitLab CI YAML formatting issue, then this is ready to merge.


Review completed using repository's CLAUDE.md guidelines

@robmorgan robmorgan changed the title docs: remove commercial content and reposition as open source docs: remove content Dec 30, 2025
@robmorgan robmorgan merged commit ca84613 into main Dec 30, 2025
4 of 5 checks passed
@robmorgan robmorgan deleted the docs/remove-commercial-content branch December 30, 2025 06:20
@claude

claude Bot commented Dec 30, 2025

Copy link
Copy Markdown
Contributor

PR Review: Documentation Cleanup and Open Source Positioning

Thank you for this significant documentation restructure! This is a positive move toward clarifying InfraSpec's open source positioning. Here's my detailed review:


✅ Strengths

Strong Strategic Direction

  • Clear messaging: Removing commercial pages and emphasizing the free, built-in emulator significantly improves the open source positioning
  • Better information architecture: Moving Virtual Cloud to the docs section (under /docs/virtual-cloud/) provides better discoverability
  • Simplified UX: The streamlined GetStartedModal focuses users on the CLI installation path

Quality Documentation

  • virtual-cloud/overview.mdx is excellent:
    • Clear value proposition with specific pain points addressed
    • Strong comparison table with LocalStack that is fair and informative
    • Comprehensive FAQ section
    • Good use of Nextra components (Callout, Steps, Tabs)
    • CI/CD examples for multiple platforms

Code Quality

  • GetStartedModal.tsx: Clean component structure with proper hooks usage, keyboard navigation (Escape), and accessibility features
  • Consistent formatting: Proper indentation and structure throughout

🐛 Issues Found

1. Broken Link Reference (Medium Priority)

Location: website/src/content/docs/virtual-cloud/overview.mdx:145

The comparison table references CloudMirror with /docs/cloudmirror but the file has been moved to /docs/virtual-cloud/cloudmirror.

Fix: Update to CloudMirror for consistency.

2. GitLab CI YAML Formatting Error (High Priority)

Location: website/src/content/docs/virtual-cloud/overview.mdx:111

The GitLab CI example has malformed YAML on line 111. It is all on one line instead of properly formatted.

Should be:

test:
  image: golang:1.24
  script:
    - curl -fsSL https://infraspec.sh/install.sh | bash
    - infraspec features/

3. Inconsistent Whitespace (Low Priority)

Locations: website/src/content/docs/virtual-cloud/overview.mdx:28, 35, 108

There are mysterious {" "} blocks that appear to be unintentional JSX whitespace. These should be removed from:

  • Line 28: Between "Fast" and "Free" divs
  • Line 35: Between "Free" and "Zero Setup" divs
  • Line 108: Between GitHub Actions and GitLab CI tabs

4. Typo (Low Priority)

Location: website/src/content/index.mdx:50

Typo on line 50: "InfaSpec" should be "InfraSpec"

5. Roadmap Grammar (Low Priority)

Location: website/src/content/docs/roadmap.mdx:4

Minor grammar issue: "Below you'll find a high-level roadmap, of the planned features."

Should be: "Below you'll find a high-level roadmap of the planned features." (remove comma)


🎯 Recommendations

Content Improvements

  1. Add transition context: Consider adding a brief note explaining this is documentation for the embedded emulator (to avoid confusion for users who may remember previous commercial messaging)

  2. Specify emulator limitations earlier: The FAQ mentions "use --live for edge cases" but it would be helpful to provide 1-2 concrete examples earlier in the doc

  3. Installation script domain: Verify that https://infraspec.sh/install.sh is set up and serving the installation script

Technical Improvements

  1. GetStartedModal width: The modal width changed from max-w-4xl to max-w-xl. This is appropriate for single-column layout, but verify it looks good across all screen sizes

  2. Dark mode testing: Ensure the new comparison table and benefit cards have proper contrast in dark mode


📋 Test Plan Additions

In addition to your test plan, please verify:

  • All internal links work correctly (especially relocated CloudMirror references)
  • The GitLab CI example can be copy-pasted and runs successfully
  • Modal keyboard navigation (Escape key) works properly
  • Copy button functionality works in both modern and legacy browsers
  • Dark mode appearance throughout all new/modified pages
  • Mobile responsiveness of the benefit cards grid
  • The install script at https://infraspec.sh/install.sh is accessible

🎨 Code Style

All changes follow project conventions from CLAUDE.md:

  • ✅ Proper file organization under website/src/content/docs/
  • ✅ Clean React component patterns
  • ✅ Consistent formatting

Summary

This is a well-executed PR with clear strategic value. The main issues to address:

High Priority:

  1. Fix the GitLab CI YAML formatting (line 111 in overview.mdx)

Medium Priority:
2. Update CloudMirror link in comparison table (line 145)

Low Priority:
3. Remove extraneous whitespace ({" "} blocks)
4. Fix typo ("InfaSpec" → "InfraSpec")
5. Fix roadmap grammar (remove comma)

Once these are addressed, this will be ready to merge. Great work simplifying the messaging and focusing on the open source value proposition! 🚀

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.

1 participant