Documentation update

[akanshaaa19]

Summary by CodeRabbit

• Documentation
  • Removed the auto-generated index for the FAQ section to simplify navigation.
  • Retired the introductory onboarding guide, consolidating guidance into other documentation areas.
  • Updated docs structure accordingly; no impact on application behavior.

[coderabbitai]

Warning

Rate limit exceeded

@akanshaaa19 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 8 minutes and 59 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between f8dc424 and bf35a54.

⛔ Files ignored due to path filters (1)

• blog/2021-08-26-welcome/docusaurus-plushie-banner.jpeg is excluded by !**/*.jpeg

📒 Files selected for processing (6)

• blog/2019-05-28-first-blog-post.md (0 hunks)
• blog/2019-05-29-long-blog-post.md (0 hunks)
• blog/2021-08-01-mdx-blog-post.mdx (0 hunks)
• blog/2021-08-26-welcome/index.md (0 hunks)
• blog/authors.yml (0 hunks)
• docusaurus.config.js (1 hunks)

Walkthrough

Removed two documentation files: docs/6. FAQ/category.json (disabling the generated index for the FAQ category) and docs/intro.md (removing the onboarding guide). No code, interfaces, or runtime behavior changes.

Changes

Cohort / File(s)	Summary of Changes
Docs removals docs/6. FAQ/_category_.json, docs/intro.md	Deleted FAQ category generated-index config and the Intro/Onboarding guide markdown.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• Update and rename intro.md to Glific Overview.md #374 — Also targets docs/intro.md by renaming/replacing it with “Glific Overview.md,” indicating overlap with this deletion.

Suggested reviewers

• SangeetaMishr
• mahajantejas

Poem

A nibble of docs, a hop through the logs,
I tidied the warren, removed two clogs.
The FAQ’s index hopped out of sight,
The intro guide took a gentle flight.
Ears up, paws clean—docs feel light tonight. 🐇✨

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch documentation-reordering

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • 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.
• 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• 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.

[github-actions]

🚀 Deployed on https://deploy-preview-401--glific-docs.netlify.app