chore: Prepare docs for website

[ahuseyn]

Description

This pull request makes documentation improvements across multiple guides in the Headless WordPress Toolkit, focusing on consistency, readability, and minor corrections. The most important changes include standardizing section headings, fixing formatting for notes, updating internal links, and improving clarity in introductory sections.

Documentation consistency and readability:

• Removed redundant "Overview" and similar introductory headings from multiple documentation files for a cleaner, more direct presentation.

Navigation and linking improvements:

• Changed internal documentation links from .md to /index.md for proper navigation between guides.

Section heading and structure updates:

• Standardized section headings from # to ## where appropriate for better hierarchy and alignment with documentation style.

Introductory and summary section improvements:

• Clarified and streamlined introductory paragraphs in root and overview documentation files, removing unnecessary repetition.

Table of contents and documentation structure:

• Removed explicit table of contents and documentation lists from the HWP Previews plugin documentation to streamline content and reduce duplication.

Related Issue

• chore: Prepare plugin, example, explanation, and how-to docs for release #502

Dependant PRs

Type of Change

• ✅ Bug fix (non-breaking change which fixes an issue)
• ✨ New feature (non-breaking change which adds functionality)
• 💥 Breaking change (fix or feature that would cause existing functionality to change)
• 🧹 Code refactoring (no functional changes)
• 📄 Example update (no functional changes)
• 📝 Documentation update
• 🔍 Performance improvement
• 🧪 Test update

How Has This Been Tested?

Screenshots

Checklist

• I have read the CONTRIBUTING document
• My code follows the project's coding standards
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation (if applicable)
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works (if applicable)
• Any dependent changes have been highlighted, merged or published

[changeset-bot]

⚠️ No Changeset found

Latest commit: 99a8a3a

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR