docs: start restructuring and add local build automation

[miyoungc]

Description

Related Issue(s)

Checklist

• I've read the CONTRIBUTING guidelines.
• I've updated the documentation if applicable.
• I've added tests if applicable.
• @mentions of the person or team responsible for reviewing proposed changes.

[greptile-apps]

Greptile Overview

Greptile Summary

This PR adds local documentation build automation and begins restructuring the documentation organization. The changes include new build scripts (serve.py, serve.sh) and a Makefile target (docs-serve) for running a live documentation server with auto-rebuild, along with comprehensive usage documentation in LIVE_DOCS.md and README.md. The documentation structure is reorganized with new landing pages (overview.md, how-it-works.md) and a tutorials index, while consolidating content from the deleted getting-started.md.

Key improvements:

• Added sphinx-autobuild and sphinx_design dependencies for enhanced documentation workflow
• Created multiple methods to serve live documentation (Makefile, Python script, bash script)
• Reorganized documentation with clearer information architecture
• Updated project name to "NVIDIA NeMo Guardrails Toolkit"

Issues found:

• Two broken links in overview.md referencing the deleted getting-started.md file (lines 70 and 114)
• Placeholder "TBD" text in main index.md needs replacement
• Repetitive introductory text in how-it-works.md

Confidence Score: 3/5

• This PR has critical broken links that will cause 404 errors in production documentation
• Score reflects two critical broken documentation links that must be fixed before merge. The build automation changes are solid, but the broken references to the deleted getting-started.md file will result in broken user experience. Additionally, placeholder content ("TBD") should be resolved.
• Pay close attention to docs/overview.md (broken links) and docs/index.md (placeholder content)

Important Files Changed

File Analysis

Filename	Score	Overview
Makefile	5/5	Added docs-serve target to enable live documentation server with auto-rebuild functionality, along with corresponding help text
docs/serve.py	5/5	New Python script to run sphinx-autobuild with configurable port, host, and browser options, includes proper error handling
pyproject.toml	5/5	Added sphinx-design and sphinx-autobuild dependencies to the docs group for enhanced documentation features and live server
docs/index.md	3/5	Restructured main documentation page with new organization, removed old content inclusion, added placeholder "TBD" text, moved getting-started.md to tutorials section
docs/overview.md	2/5	New comprehensive overview with use cases and benefits, but contains broken references to deleted getting-started.md file
docs/how-it-works.md	4/5	New landing page with card-based navigation to guardrails process and architecture guides, includes repetitive introductory text

Sequence Diagram

sequenceDiagram
    participant Dev as Developer
    participant Make as Makefile
    participant Script as serve.py/serve.sh
    participant Sphinx as sphinx-autobuild
    participant Browser as Web Browser
    
    Dev->>Make: make docs-serve
    Make->>Script: cd docs && run sphinx-autobuild
    Script->>Sphinx: Start with config (port 8000, watch patterns)
    Sphinx->>Sphinx: Initial build from source
    Sphinx->>Browser: Open http://127.0.0.1:8000
    Browser->>Dev: Display documentation
    
    loop Live Development
        Dev->>Sphinx: Save .md, .rst, or .py file
        Sphinx->>Sphinx: Detect change (1s debounce)
        Sphinx->>Sphinx: Rebuild affected pages
        Sphinx->>Browser: Push update via WebSocket
        Browser->>Browser: Auto-refresh with new content
    end
    
    Dev->>Sphinx: Ctrl+C
    Sphinx->>Make: Server stopped

Loading

[greptile-apps]

_{13 files reviewed, 4 comments}

_{Edit Code Review Agent Settings | Greptile}

[github-actions]

Documentation preview

https://nvidia-nemo.github.io/Guardrails/review/pr-1528

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[Pouyanpi]

Thank you @miyoungc , nice job 🚀 I agree - better to merge it and iterate further from there.

p.s. I still see AlignScore under "Integration" section but that could be fixed later.

[cparisien]

I really like the new structure. There are a lot of changes here so let's merge with what we have and then iterate with PRs from the eng team. Thanks a lot Miyoung for this nice work!

[miyoungc]

Thank you @miyoungc , nice job 🚀 I agree - better to merge it and iterate further from there.

p.s. I still see AlignScore under "Integration" section but that could be fixed later.

Please feel free to move the AlignScore to a better place, or let me know where it should be.