Feature/ux improvements #2968
Feature/ux improvements #2968
Conversation
WalkthroughThe pull request introduces modifications to the documentation website's configuration and styling. The changes primarily focus on updating the navbar configuration in Changes
Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
📜 Recent review detailsConfiguration used: .coderabbit.yaml 📒 Files selected for processing (1)
⏰ Context from checks skipped due to timeout of 90000ms (2)
🔇 Additional comments (4)
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 using PR comments)
Other keywords and placeholders
Documentation and Community
|
Our Pull Request Approval ProcessThanks for contributing! Testing Your CodeRemember, your PRs won't be reviewed until these criteria are met:
Our policies make our code better. ReviewersDo not assign reviewers. Our Queue Monitors will review your PR and assign them.
Reviewing Your CodeYour reviewer(s) will have the following roles:
CONTRIBUTING.mdRead our CONTRIBUTING.md file. Most importantly:
Other
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop-postgres #2968 +/- ##
=================================================
Coverage 39.85% 39.85%
=================================================
Files 453 453
Lines 33203 33203
Branches 385 385
=================================================
Hits 13234 13234
Misses 19969 19969 ☔ View full report in Codecov by Sentry. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (2)
docs/docusaurus.config.ts(1 hunks)docs/src/css/custom.css(4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Run tests for talawa api
- GitHub Check: Analyse Code With CodeQL (typescript)
🔇 Additional comments (2)
docs/docusaurus.config.ts (1)
64-65: LGTM! Navigation improvements look good.The changes improve navigation consistency by:
- Adding proper href to the logo
- Ensuring links open in the same tab
- Updating the "General" link to point to the docs section
Also applies to: 71-72
docs/src/css/custom.css (1)
124-126: LGTM! Menu styling improvements look good.The increased font size improves readability.
Our Pull Request Approval ProcessThanks for contributing! Testing Your CodeRemember, your PRs won't be reviewed until these criteria are met:
Our policies make our code better. ReviewersDo not assign reviewers. Our Queue Monitors will review your PR and assign them.
Reviewing Your CodeYour reviewer(s) will have the following roles:
CONTRIBUTING.mdRead our CONTRIBUTING.md file. Most importantly:
Other
|
|
When the shared CSS is used (hopefully from docs.talawa.io), the vertical spacing of items in the left drawer will need to be reduced. |
palisadoes
merged commit 28859b2
into
PalisadoesFoundation:develop-postgres
What kind of change does this PR introduce?
Update navbar and sidebar to match that of Talawa docs.
Navbar
Before:
Talawa-API.1.mp4
After:
Talawa-API.2.mp4
Sidebar
Before:
Talawa-API.3.mp4
After:
Talawa-API.4.mp4
Issue Number:
Fixes #2951 Part 1
Snapshots/Videos:
If relevant, did you update the documentation?
Not relevant
Summary
Fixes part of the issue #2951 by updating the navbar and sidebar to match that of Talawa docs.
Does this PR introduce a breaking change?
No
Checklist
CodeRabbit AI Review
Test Coverage
Other information
Have you read the contributing guide?
Yes
Summary by CodeRabbit
Documentation
Style