Update content for environments page (#1008) #1013
Conversation
* Update content for environments page * Add new changes * File structure * Update content/docs/platform/developer/environments.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> * Update content/docs/platform/developer/environments.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> * Update content/docs/platform/developer/environments.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> * Update content/docs/platform/developer/environments.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> * Update content/docs/platform/developer/environments.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> * Update content/docs/platform/developer/environments.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> * Update content/docs/platform/developer/environments.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> * Update content/docs/platform/developer/environments.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> * Revert "File structure" This reverts commit 5a59916. * Update content based on Diana's feedback * Update content/docs/platform/developer/environments.mdx Co-authored-by: DianaHackmamba <diana@hackmamba.io> --------- Co-authored-by: DianaHackmamba <diana@hackmamba.io>
✅ Deploy Preview for docs-novu ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
WalkthroughThis PR reorganizes platform documentation by relocating the environments guide from the concepts section to the developer section. It updates navigation metadata to reflect this restructuring, introducing a new Developer section in the platform documentation hierarchy and repositioning the Account section accordingly. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
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. Comment |
![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 (1)
content/docs/platform/developer/environments.mdx (1)
73-88: Consider refining repetitive phrasing in step 4 of the publishing workflow.All three image assets referenced in the publishing workflow are verified and exist. The only remaining suggestion is to improve readability by varying the wording in step 4:
-4. Select the checkboxes next to the workflows that you want to publish. A menu appears, showing all the available workflows. +4. Select the checkboxes for the workflows to publish. A menu appears, showing all the available workflows.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
content/docs/platform/concepts/environments.mdx(0 hunks)content/docs/platform/developer/environments.mdx(1 hunks)content/docs/platform/developer/meta.json(1 hunks)content/docs/platform/meta.json(1 hunks)
💤 Files with no reviewable changes (1)
- content/docs/platform/concepts/environments.mdx
🧰 Additional context used
🪛 LanguageTool
content/docs/platform/developer/environments.mdx
[style] ~86-~86: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...eckboxes next to the workflows that you want to publish. A menu appears, showing all th...
(REP_WANT_TO_VB)
⏰ 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). (4)
- GitHub Check: Redirect rules - docs-novu
- GitHub Check: Header rules - docs-novu
- GitHub Check: Pages changed - docs-novu
- GitHub Check: Build and Lint
🔇 Additional comments (6)
content/docs/platform/meta.json (1)
34-41: Navigation hierarchy restructured correctly.The reorganization introduces the Developer section with the environments guide before the Account section, maintaining proper JSON structure and alignment with the new file metadata. The repositioning reflects the PR's objective of moving environment documentation to the developer section.
content/docs/platform/developer/environments.mdx (4)
1-5: Frontmatter looks good.
9-17: Environment types section is clear and well-structured.The distinction between Development (edit sandbox), Production (view-only for safety), and Custom environments (plan-gated) is clearly explained with proper security attributes on external links.
56-71: Documentation link verified—no issues found.The internal documentation path
/platform/inbox/overviewcorrectly referencescontent/docs/platform/inbox/overview.mdxand is properly configured. The credentials section appropriately distinguishes between public (Application Identifier) and private (API Secret Key) credentials with clear security guidance.
19-30: No issues identified—all references verified and correct.The image asset
create-environment.pngexists at the documented path, and the Novu Cloud Dashboard athttps://dashboard.novu.co/environmentsis accessible and valid. The step-by-step instructions are accurate and well-structured.content/docs/platform/developer/meta.json (1)
2-2: Developer metadata correctly updated.The pages list now includes "environments" alongside "webhooks," properly reflecting the new environments documentation file and aligning with the navigation structure updates in the parent platform metadata.
| icon: 'GitFork' | ||
| --- | ||
|
|
||
| Novu uses environments to separate your workflows and it's data. This lets you safely test changes, like a new workflow, in one environment before moving it to a live production environment. |
There was a problem hiding this comment.
Fix possessive pronoun.
Line 7 should use "its" (possessive) instead of "it's" (contraction of "it is").
-Novu uses environments to separate your workflows and it's data. This lets you safely test changes, like a new workflow, in one environment before moving it to a live production environment.
+Novu uses environments to separate your workflows and its data. This lets you safely test changes, like a new workflow, in one environment before moving it to a live production environment.📝 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.
| Novu uses environments to separate your workflows and it's data. This lets you safely test changes, like a new workflow, in one environment before moving it to a live production environment. | |
| Novu uses environments to separate your workflows and its data. This lets you safely test changes, like a new workflow, in one environment before moving it to a live production environment. |
🤖 Prompt for AI Agents
In content/docs/platform/developer/environments.mdx around line 7, replace the
contraction "it's" with the possessive "its" so the sentence reads "Novu uses
environments to separate your workflows and its data." Ensure only the single
word is changed and punctuation/spacing remains unchanged.
| ## What's unique to each environment? | ||
|
|
||
| Each environment in Novu has it's own isolated resources, while the development environment has assets that can be published to other environments. | ||
|
|
||
| Each environment maintains some isolated set of resources, while you can share or promote other assets through publishing. | ||
|
|
There was a problem hiding this comment.
Fix possessive pronoun and reduce redundancy in environment overview.
Lines 34 and 36 convey similar concepts with slight rewording. Additionally, line 34 contains the same grammar error (it's → its). Consider consolidating these introductory sentences for clarity.
-Each environment in Novu has it's own isolated resources, while the development environment has assets that can be published to other environments.
-
-Each environment maintains some isolated set of resources, while you can share or promote other assets through publishing.
+Each environment in Novu has its own isolated resources, while the development environment has assets that can be published to other environments.📝 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.
| ## What's unique to each environment? | |
| Each environment in Novu has it's own isolated resources, while the development environment has assets that can be published to other environments. | |
| Each environment maintains some isolated set of resources, while you can share or promote other assets through publishing. | |
| ## What's unique to each environment? | |
| Each environment in Novu has its own isolated resources, while the development environment has assets that can be published to other environments. |
🤖 Prompt for AI Agents
In content/docs/platform/developer/environments.mdx around lines 32 to 37, the
two introductory sentences are redundant and line 34 uses the incorrect
possessive "it's" instead of "its"; consolidate them into a single clear
sentence that uses "its" and communicates that each environment has isolated
resources while development assets can be published/promoted to other
environments to remove repetition and fix the grammar.
Update content for environments page
Add new changes
File structure
Update content/docs/platform/developer/environments.mdx
Update content/docs/platform/developer/environments.mdx
Update content/docs/platform/developer/environments.mdx
Update content/docs/platform/developer/environments.mdx
Update content/docs/platform/developer/environments.mdx
Update content/docs/platform/developer/environments.mdx
Update content/docs/platform/developer/environments.mdx
Update content/docs/platform/developer/environments.mdx
Revert "File structure"
This reverts commit 5a59916.
Update content based on Diana's feedback
Update content/docs/platform/developer/environments.mdx
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.