feat: Adding site-wide banner to collect feedback

[yhakbar]

Description

Adds a global banner to the v1 docs site that indicates it's under construction, where to look at the status, and how to give feedback.

TODOs

Read the Gruntwork contribution guidelines.

• Update the docs.
• Run the relevant tests successfully, including pre-commit checks.
• Ensure any 3rd party code adheres with our license policy or delete this line if its not applicable.
• Include release notes. If this PR is backward incompatible, include a migration guide.

Release Notes (draft)

Added global banner.

Summary by CodeRabbit

• New Features
  • Introduced a centralized banner on the documentation site that now announces the ongoing website redesign and provides links for user feedback.
• Documentation
  • Updated the project task list to mark the user feedback collection milestone as complete.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
terragrunt-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 7, 2025 4:17pm

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

This pull request updates the Terragrunt website documentation and configuration. In docs-starlight/TODO.md, the "User feedback collection" task is marked as completed. The schema in docs-starlight/src/content.config.ts has been extended with a new banner object that includes a default HTML message. In docs-starlight/src/content/docs/index.mdx, the previously visible banner message regarding the redesign status has been removed.

Changes

File(s)	Change Summary
docs-starlight/TODO.md	Marked the "User feedback collection" task as completed.
docs-starlight/src/content.config.ts docs-starlight/src/content/docs/index.mdx	Extended the docs schema with a new banner object containing a default HTML message in the config, and removed the corresponding banner message from the docs.

Possibly related PRs

• feat: Adding Docker Compose for local dev #3847: Updates a similar task in the TODO.md file by marking the "Docker compose local dev setup" as completed.

Suggested reviewers

• levkohimins
• denis256

Poem

A task is done, a banner reborn,
In docs and code, a new dawn is born.
The warnings of progress fade away,
As updates sparkle like light in the day.
Cheers to change – here’s to bright new art! 🎉

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8a2f17b and 709d021.

📒 Files selected for processing (3)

• docs-starlight/TODO.md (1 hunks)
• docs-starlight/src/content.config.ts (1 hunks)
• docs-starlight/src/content/docs/index.mdx (0 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

The base branch was changed.