docs: add usage guide #52
Conversation
WalkthroughThe updates introduce a comprehensive usage guide for the Transcript Summarizer application, detailing its purpose, setup instructions, and operational procedures. Additionally, the branding of the portal has been updated from "OsmoX Portal" to "Transcript Summarizer Portal," ensuring consistent terminology throughout the documentation. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
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 as PR comments)
Additionally, you can add CodeRabbit Configuration File (
|
kshitij-k-osmosys
added
documentation
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
Outside diff range, codebase verification and nitpick comments (1)
apps/portal/docs/development-setup.md (1)
3-3: Clarify document purpose in the introduction.The introduction should briefly explain the purpose of the document to set the right context for new developers.
Consider adding a sentence about the document's aim to guide developers through setting up the development environment for the Transcript Summarizer Portal.
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- apps/api/docs/usage-guide.md (1 hunks)
- apps/portal/docs/development-setup.md (2 hunks)
Additional context used
LanguageTool
apps/portal/docs/development-setup.md
[style] ~10-~10: To form a complete sentence, be sure to include a subject.
Context: ... - Node.js Node.js v20.x or higher. Can be installed vianvmusing `nvm insta...(MISSING_IT_THERE)
apps/api/docs/usage-guide.md
[uncategorized] ~28-~28: The grammatical number of this noun doesn’t look right. Consider replacing it.
Context: ...up the Portal environment based on your requirement: - [Development Environment](../../por...(AI_EN_LECTOR_REPLACEMENT_NOUN_NUMBER)
[uncategorized] ~55-~55: You might be missing the article “the” here.
Context: ...Process the Transcript** - Click onSummarize Mebutton to process your tra...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[misspelling] ~72-~72: Did you mean the verb “log in” instead of the noun ‘login’?
Context: ...the portal URL. You will be prompted to login to your Microsoft account. 5. Before pr...(LOG_IN)
Additional comments not posted (4)
apps/portal/docs/development-setup.md (2)
7-7: Ensure version specificity for prerequisites.The document lists prerequisites with specific versions, which is good practice.
This ensures that developers set up their environment with the correct versions, avoiding compatibility issues.
59-59: Confirm the default port and handling of port conflicts.The document mentions that the development server runs at
http://localhost:4200and handles port conflicts. It's important to ensure that this behavior is correctly implemented in the server configuration.apps/api/docs/usage-guide.md (2)
1-1: Excellent introduction to the usage guide.The title clearly indicates the purpose of the document.
This helps users immediately understand that the document will guide them through using the Transcript Summarizer.
5-5: Engaging introduction section.The introduction does a good job of welcoming users and setting the context for the Transcript Summarizer.
It effectively communicates the purpose of the application and the document.
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- apps/api/docs/usage-guide.md (1 hunks)
- apps/portal/docs/development-setup.md (3 hunks)
Additional context used
LanguageTool
apps/portal/docs/development-setup.md
[style] ~10-~10: To form a complete sentence, be sure to include a subject.
Context: ... - Node.js Node.js v20.x or higher. Can be installed vianvmusing `nvm insta...(MISSING_IT_THERE)
apps/api/docs/usage-guide.md
[uncategorized] ~23-~23: You might be missing the article “the” here.
Context: ...ob-status-information) ## 1. Overview Transcript Summarizer is a powerful tool designed ...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~54-~54: You might be missing the article “the” here.
Context: ...stored locally in the path specified in.envfile. - Default storage folder...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
Additional comments not posted (10)
apps/portal/docs/development-setup.md (4)
3-3: LGTM!The introduction is clear and concise.
The code changes are approved.
7-10: Correct grammatical issues in prerequisites.The static analysis tool flagged a grammatical issue in the prerequisites section.
Consider revising the sentence to include a subject for completeness:
- **Node.js** Node.js v20.x or higher. Can be installed via `nvm` using `nvm install 20` and used with `nvm use 20`. + **Node.js:** Node.js v20.x or higher can be installed via `nvm` using `nvm install 20` and used with `nvm use 20`.Tools
LanguageTool
[style] ~10-~10: To form a complete sentence, be sure to include a subject.
Context: ... - Node.js Node.js v20.x or higher. Can be installed vianvmusing `nvm insta...(MISSING_IT_THERE)
13-13: Add more details to the prerequisites section.While the prerequisites are listed, it might be helpful to include more detailed instructions or links on how to install these tools, especially for less experienced developers.
Would you like me to add detailed installation instructions or links for these tools?
32-43: LGTM!The configuration instructions are clear and provide necessary details for setting up the environment.
The code changes are approved.
apps/api/docs/usage-guide.md (6)
1-5: LGTM!The introduction is clear and concise.
The code changes are approved.
7-21: LGTM!The table of contents is well-organized and provides a clear structure for the document.
The code changes are approved.
28-31: Clarify authorization requirements.The setup section mentions the need for a valid Microsoft account but does not specify how to authorize it for the specific tenantId, clientId, and apiScope.
Consider adding a subsection on how to obtain and configure these credentials for new users or link to a relevant section if it exists.
42-62: Grammar correction needed in the processing instructions.The static analysis tool flagged a missing article before "Summarize Me" button.
Apply this correction to improve readability:
- Click on `Summarize Me` button to process your transcript. + Click on the `Summarize Me` button to process your transcript.Tools
LanguageTool
[uncategorized] ~54-~54: You might be missing the article “the” here.
Context: ...stored locally in the path specified in.envfile. - Default storage folder...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
50-50: Correct usage of "log in."The document incorrectly uses "login" as a verb.
Correct this to maintain proper grammar:
- You will be prompted to login to your Microsoft account. + You will be prompted to log in to your Microsoft account.
28-28: Grammatical number issue in setup instructions.The static analysis tool flagged a potential issue with the grammatical number in the setup instructions.
Consider revising the sentence for grammatical accuracy:
- Ensure you have set up the Portal environment based on your requirement: + Ensure you have set up the Portal environment based on your requirements:
2 participants
API PR Checklist
Pre-requisites
PR Details
PR details have been updated as per the given format (see below)
feat: add admin login endpoint)Additional Information
ready for reviewshould be added if the PR is ready to be reviewed)Description:
Related changes:
NA
Screenshots:
NA
Query request and response:
NA
Documentation changes:
Test suite output:
NA
Pending actions:
NA
Additional notes:
NA
Summary by CodeRabbit