docs: remove ‘Beta’ label #58
Conversation
WalkthroughReferences to "Beta" were removed from the documentation for GSTR-1, GST Sales Register, and GST Purchase Register reports. Headings, descriptions, navigation instructions, image captions, and filenames were updated to reflect the transition from beta to stable releases. No procedural or feature changes were made to the documented workflows. Changes
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (7)
pages/docs/gst-reports/miscellaneous_reports.md (4)
75-77: Heading is fine, but the intro sentence is missing a determiner“The GST Sales Register Report provides:” reads correctly, but the preceding blank line after the heading is missing, which breaks markdown-lint MD022 (headings should be surrounded by blank lines). Add a blank line for consistency and parser friendliness.
83-86: Add the definite article and optional capitalisation fix“To view GST Sales Register report navigate to …” → “To view the GST Sales Register report, navigate to …”
Also consider “Awesome Bar” (the UI label) instead of “awesomebar”.-To view GST Sales Register report navigate to **Accounts > GST India > GST -Sales Register** +To view the GST Sales Register report, navigate to **Accounts > GST India > GST Sales Register**
88-91: Alt-text is too genericBoth images use identical, non-descriptive alt text (“Sales Register Overview / Detail View”). Screen-reader users get no context. Incorporate the report name and the purpose, e.g. “GST Sales Register – Overview grid”.
93-108: Same grammatical issues as Sales Register section
- Missing blank line after the
## GST Purchase Register Reportheading.- “To view GST Purchase Register report navigate …” → add “the”, capitalise “GST India”.
- Alt-text again very generic.
Apply the same fixes as suggested above for consistency.
pages/docs/gst-reports/gstr1.md (3)
25-25: Extraneous definite article“Simplify GSTR-1 filing, and file with confidence using the GSTR-1.”
The definite article isn’t needed.-Simplify GSTR-1 filing, and file with confidence using the GSTR-1. +Simplify GSTR-1 filing, and file with confidence using GSTR-1.
55-55: Optional: shorten and avoid repetitionYou refer to “GSTR-1” three times in one sentence. Consider trimming for readability.
-Navigate to **GSTR-1** and select the period and company for which you want to generate the GSTR-1 report. Click on the `Generate` button. +Open **GSTR-1**, select the required period and company, then click **Generate**.
68-113: Image alt-text is identical and non-descriptiveEvery embedded image has alt text “GSTR-1”. Screen-reader users cannot tell the difference between components, tabs, error dialog, etc. Provide meaningful alt text such as “GSTR-1 components overview”, “GSTR-1 error tab with validation messages”, etc.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (4)
pages/docs/gst-reports/assets/purchase_register_detail_view.pngis excluded by!**/*.pngpages/docs/gst-reports/assets/purchase_register_overview.pngis excluded by!**/*.pngpages/docs/gst-reports/assets/sales_register_detail_view.pngis excluded by!**/*.pngpages/docs/gst-reports/assets/sales_register_overview.pngis excluded by!**/*.png
📒 Files selected for processing (2)
pages/docs/gst-reports/gstr1.md(5 hunks)pages/docs/gst-reports/miscellaneous_reports.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
pages/docs/gst-reports/miscellaneous_reports.md
[grammar] ~75-~75: Use correct spacing
Context: ... determined. ::: ## GST Sales Register Report The GST Sales Register Report provides:...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~77-~77: Use correct spacing
Context: ...r Report The GST Sales Register Report provides: - An overview of all sales transactions m...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~81-~81: Use correct spacing
Context: ... of transactions. - HSN-Wise summary of transactions. To view GST Sales Register report navig...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~83-~83: Use articles correctly
Context: ...-Wise summary of transactions. To view GST Sales Register report navigate to **Acc...
(QB_NEW_EN_OTHER_ERROR_IDS_11)
[grammar] ~83-~83: There might be a mistake here.
Context: ...ansactions. To view GST Sales Register report navigate to **Accounts > GST India > GS...
(QB_NEW_EN_OTHER)
[grammar] ~83-~83: There might be a problem here.
Context: ...rt navigate to Accounts > GST India > GST Sales Register or simply search for GST Sales Register...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~86-~86: There might be a problem here.
Context: ...simply search for GST Sales Register in awesomebar. 
## GST Purchase Register Report The GST P...
(QB_NEW_EN_MERGED_MATCH)
[grammar] ~92-~92: Use correct spacing
Context: ...ail_view.png) ## GST Purchase Register Report The GST Purchase Register Report provid...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~94-~94: Use correct spacing
Context: ...eport The GST Purchase Register Report provides: - An overview of all purchases made durin...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~97-~97: Add a conjunction or punctuation
Context: ... comprehensive summary based on various categories - A detailed breakdown of each transact...
(QB_NEW_EN_OTHER_ERROR_IDS_16)
[grammar] ~98-~98: Use correct spacing
Context: ... breakdown of each transaction based on category. To view GST Purchase Register report na...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~100-~100: Use articles correctly
Context: ...transaction based on category. To view GST Purchase Register report navigate to **...
(QB_NEW_EN_OTHER_ERROR_IDS_11)
[grammar] ~100-~100: There might be a mistake here.
Context: ...ategory. To view GST Purchase Register report navigate to **Accounts > GST India > GS...
(QB_NEW_EN_OTHER)
[grammar] ~100-~100: Use correct spacing
Context: ...port navigate to Accounts > GST India > GST Purchase Register or simply search f...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~101-~101: There might be a mistake here.
Context: ...o Accounts > GST India > GST Purchase Register or simply search for GST Purchase Regis...
(QB_NEW_EN_OTHER)
[grammar] ~103-~103: There might be a problem here.
Context: ...ply search for GST Purchase Register in awesomebar. 
(QB_NEW_EN_MERGED_MATCH)
pages/docs/gst-reports/gstr1.md
[grammar] ~23-~23: Use correct spacing
Context: ...GSTR-1 returns. ## GSTR-1 ### Feature Highlights Simplify GSTR-1 filing, and file with c...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~25-~25: Use correct spacing
Context: ...ing, and file with confidence using the GSTR-1. - Seamless API Integration: Effortlessl...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~29-~29: Use correct spacing
Context: ...ces once GSTR-1 is filed, ensuring data integrity. ### Setting up To get stated with GSTR-1, ...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~31-~31: Use correct spacing
Context: ..., ensuring data integrity. ### Setting up To get stated with GSTR-1, make sure yo...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~33-~33: Use the right verb tense
Context: ...data integrity. ### Setting up To get stated with GSTR-1, make sure you have complet...
(QB_NEW_EN_OTHER_ERROR_IDS_13)
[grammar] ~33-~33: Use correct spacing
Context: ...e sure you have completed the following steps: #### Configure GST Settings Navigate to **G...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~54-~54: Use correct spacing
Context: ... GSTR-1 report. Click on the Generate button. For API features, an OTP may be require...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~70-~70: Use correct spacing
Context: ...mponents.png) ### Compare, Export, and File 
More control with JSON Export - Excl...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~76-~76: Use correct spacing
Context: ...iled_tab.png) More control with JSON Export - Exclude previously uploaded data from J...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~79-~79: Use correct spacing
Context: ... the GST Portal that are absent in your books. 
### Compare Historical Data 
[grammar] ~83-~83: Use correct spacing
Context: ...n_download.png) ### Compare Historical Data 
### Reset GSTR-1 - To reset the GSTR-1 dat...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~87-~87: Use correct spacing
Context: ..._historical_comparision.png) ### Reset GSTR-1 - To reset the GSTR-1 data for the select...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~89-~89: Use correct spacing
Context: ...data for the selected period on the GST Portal, click the Reset button and confirm the...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~131-~131: Use correct spacing
Context: ...Filing status will change to Filed, and the data will be re-downloaded for comparison wi...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~132-~132: Use correct spacing
Context: ...ownloaded for comparison with the final summary. 
- If there are any sales reverse charge e...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
[grammar] ~136-~136: Use correct spacing
Context: ...- If there are any sales reverse charge entries, a dialog will appear after successful fi...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
🪛 markdownlint-cli2 (0.17.2)
pages/docs/gst-reports/gstr1.md
76-76: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Codacy Static Code Analysis
| ### Setting up | ||
|
|
||
| To get stated with GSTR-1 Beta, make sure you have completed the following steps: | ||
| To get stated with GSTR-1, make sure you have completed the following steps: |
There was a problem hiding this comment.
Typo: “stated” → “started”
This is user-visible and should be corrected.
-To get stated with GSTR-1, make sure you have completed the following steps:
+To get started with GSTR-1, make sure you have completed the following steps:📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| To get stated with GSTR-1, make sure you have completed the following steps: | |
| To get started with GSTR-1, make sure you have completed the following steps: |
🧰 Tools
🪛 LanguageTool
[grammar] ~33-~33: Use the right verb tense
Context: ...data integrity. ### Setting up To get stated with GSTR-1, make sure you have complet...
(QB_NEW_EN_OTHER_ERROR_IDS_13)
[grammar] ~33-~33: Use correct spacing
Context: ...e sure you have completed the following steps: #### Configure GST Settings Navigate to **G...
(QB_NEW_EN_OTHER_ERROR_IDS_5)
🤖 Prompt for AI Agents
In pages/docs/gst-reports/gstr1.md at line 33, correct the typo by changing the
word "stated" to "started" in the sentence to ensure proper user-visible text.
| ## GSTR-1 | ||
|
|
There was a problem hiding this comment.
Redundant second-level heading – breaks hierarchy
## GSTR-1 immediately follows the top-level # GSTR-1. This is noise and confuses screen-reader heading navigation. Remove the duplicate H2.
-## GSTR-1
-📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## GSTR-1 |
🤖 Prompt for AI Agents
In pages/docs/gst-reports/gstr1.md around lines 21 to 22, there is a redundant
second-level heading '## GSTR-1' immediately following the top-level '# GSTR-1'.
Remove this duplicate H2 heading to maintain proper heading hierarchy and
improve screen-reader navigation.
|
Additionally we can add v16 change log |
|
We should have versioning for docs too. Old users can be redirected to old docs and new ones can be to new docs. We need to think of a framework on how we can achieve this. |
2 participants
Updates According to: india-compliance#3506
Summary by CodeRabbit