Feature/admin docs refactor/admin-doc to hashura docs style #3100
Conversation
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
|
WalkthroughThis pull request introduces comprehensive updates to the Talawa Admin documentation website's configuration and styling. The changes focus on modernizing the documentation's appearance and navigation structure by updating the Docusaurus configuration, revamping the CSS variables, and simplifying the homepage layout. The modifications aim to create a more professional and intuitive documentation experience with improved branding and visual design. Changes
Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Tip CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command 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
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/src/css/custom.css (2)
9-47: New CSS variables for custom theming.
- The redefined color palette (e.g.,
--secondary-blue-900,--sidebar-bg-color, etc.) is more descriptive. Make sure these semantic names (e.g.,--primary-neutral-800) are intuitive across larger sections of the code.- Confirm that the chosen color tokens are consistent with the brand guidelines (palisadoesfoundation).
78-150: Global UI element styling updates.Blocks of styling for code highlighting, table-of-contents font sizes, navbar backgrounds, hover states, etc., reflect a push for a cohesive visual identity. Verify that no critical Infima or Docusaurus classes are inadvertently overridden, especially for large tables or multi-column layouts.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (12)
docs/static/img/icons/facebook.svgis excluded by!**/*.svgdocs/static/img/icons/favicon_palisadoes.icois excluded by!**/*.icodocs/static/img/icons/github-dark.svgis excluded by!**/*.svgdocs/static/img/icons/github.svgis excluded by!**/*.svgdocs/static/img/icons/instagram.svgis excluded by!**/*.svgdocs/static/img/icons/opportunities.svgis excluded by!**/*.svgdocs/static/img/icons/slack.svgis excluded by!**/*.svgdocs/static/img/icons/source.svgis excluded by!**/*.svgdocs/static/img/icons/team.svgis excluded by!**/*.svgdocs/static/img/icons/twitter.svgis excluded by!**/*.svgdocs/static/img/icons/youtube-white.svgis excluded by!**/*.svgdocs/static/img/icons/youtube.svgis excluded by!**/*.svg
📒 Files selected for processing (3)
docs/docusaurus.config.ts(2 hunks)docs/src/css/custom.css(1 hunks)docs/src/pages/index.tsx(1 hunks)
🔇 Additional comments (7)
docs/src/pages/index.tsx (1)
13-13: Streamlined header style.
The removal of the hero hero--primary classes in favor of styles.heroBanner is fine if the new class definition ensures consistent styling across different themes (e.g. dark mode). Verify that no Docusaurus built-in styles are lost that were previously provided by the removed classes.
docs/docusaurus.config.ts (2)
9-10: Tagline and favicon updates.
The new tagline more clearly communicates the scope of the documentation. Also, switching to a custom favicon is a good branding move. Just confirm that the updated path img/icons/favicon_palisadoes.ico is correct and that the icon renders as expected.
48-172: Extensive theme configuration enhancements.
- The updated navbar items (General, Mobile Guide, Admin Guide, API Guide, Demo, etc.) offer clear entry points. Double-check that all target links (like
docs-mobile.talawa.io,docs-api.talawa.io) are valid and do not produce redirect errors. - Including color mode handling (light/dark toggling) shows a user-centric design. Ensure that the dark mode palette defined in the CSS file corresponds correctly to these settings.
- The new footer social links and community sections are more comprehensive. Confirm that these links are all functional and accurate (e.g., Slack, Twitter, etc.).
docs/src/css/custom.css (4)
5-5: Infima variable overrides note.
This comment line indicates the intention to override default Infima variables. Ensure that your newly introduced variables comprehensively replace the old color definitions (e.g., --ifm-color-primary, etc.) and that no references to the removed variables remain in the codebase.
49-76: Dark mode style variables.
You’ve introduced specific overrides (e.g., --ifm-background-color, --ifm-color-content) ensuring good contrast in dark mode. Review that text, borders, and backgrounds remain accessible under common color-blindness scenarios (e.g., use additional checks or tools to confirm).
211-242: Custom icon usage in the header links.
You’re loading custom SVG icons for GitHub, Twitter, YouTube, etc. Confirm that the icons exist at the specified paths (e.g. /img/icons/github-dark.svg), and that their backgrounds look correct in both light and dark modes.
244-424: Footer theming and responsive design.
- The
.footer--darkoverride plus the link-based custom icons are consistent with the new palette. Double-check that external link usage (e.g., Slack, Facebook, Instagram) is functional. - The media queries properly handle responsive layouts for smaller viewports. Confirm that brand buttons (YouTube, GitHub) and navbar items display as intended on phones and tablets.
palisadoes
added
the
ignore-sensitive-files-pr
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop-postgres #3100 +/- ##
=====================================================
+ Coverage 26.39% 89.25% +62.85%
=====================================================
Files 301 322 +21
Lines 7588 8421 +833
Branches 1657 1839 +182
=====================================================
+ Hits 2003 7516 +5513
+ Misses 5454 670 -4784
- Partials 131 235 +104 ☔ View full report in Codecov by Sentry. |
palisadoes
merged commit 04d773a
into
PalisadoesFoundation:develop-postgres
What kind of change does this PR introduce?
This PR introduces completion of first part of issue #2970
Issue Number:
Fixes #2970
Did you add tests for your changes?
No, no testing need. Manual visual testing was done.
Snapshots/Videos:
If relevant, did you update the documentation?
No, Documentation update not applicable here
Summary
This PR is a start to build a whole new doc web for talawa-admin, emphasis was given on giving the website similar look to hashura's website and to keep consistence css (color scheme, fonts and typography) all over the web
Does this PR introduce a breaking change?
No
Other information
Have you read the contributing guide?
Yes
Summary by CodeRabbit
New Features
Style
Documentation