refactor: admin-doc to hasura docs style #3098
Conversation
WalkthroughThis pull request focuses on updating the Docusaurus documentation configuration and styling for the Talawa Admin documentation site. The changes include modifications to the Docusaurus configuration file, a comprehensive update to the CSS styling, and simplification of the homepage header. The updates aim to enhance the documentation's navigation, resource accessibility, and visual consistency across different themes and screen sizes. Changes
Assessment against linked issues
Possibly related 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
|
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
|
![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 (5)
docs/docusaurus.config.ts (2)
56-107: Comprehensive navbar reconfiguration.The updated navbar items effectively improve discoverability of resources. Ensure external links open in a new tab only where necessary (e.g., third-party websites) to maintain consistent user experience.
108-112: Color mode toggles are beneficial.
disableSwitch: falseandrespectPrefersColorScheme: falseallow manual toggling. If you’d like to detect user preference by default, consider settingrespectPrefersColorScheme: true.docs/src/css/custom.css (3)
49-50: Typographical fix for “Dak mode css”.A minor but noticeable typo exists in the comment “/* Dak mode css /”. Change it to “/ Dark mode css */” for clarity.
-/* Dak mode css */ +/* Dark mode css */
51-62: Dark mode variable overrides.Ensure the updated background and text colors meet accessibility guidelines (e.g., contrast ratio). Consider running an automated contrast check to confirm compliance.
389-397: Heading color usage.You’re using
--secondary-blue-900for headings. Verify that primary text color remains distinct and consistent, especially in mobile view.
📜 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 (8)
docs/src/pages/index.tsx (1)
13-13: Ensure consistent layout alignment with new styles.
You removed the hero hero--primary classes but retained styles.heroBanner. Verify that the banner’s spacing and styling are consistent with the newly introduced design scheme throughout the documentation website.
docs/docusaurus.config.ts (4)
9-10: Tagline and favicon updates look good.
Changing the tagline to “Complete guides and references for building with Talawa” and updating the favicon are aligned with the PR's objective to strengthen branding and clarity.
48-55: Confirm theming references.
You have introduced an expanded themeConfig at lines 48-55. Verify that custom CSS variables declared in custom.css are recognized during build.
113-168: Footer structure successfully expanded.
The multi-column approach with Community, Social Media, and Development sections enhances readability. Ensure all external links are valid and remain up-to-date.
169-172: Prism theme usage looks correct.
Using GitHub and Dracula themes is a standard approach. Confirm the code blocks render correctly in both themes.
docs/src/css/custom.css (3)
9-16: New color variables align with the Hasura-like design approach.
The introduction of --secondary-blue-900 and other neutral tones reflects the modern style. Confirm that these variables do not conflict with any existing CSS or Infima defaults.
94-107: Menu styling is concise.
The .menu selectors, link line-height, and uppercase transformations achieve a clean, minimalistic look. No obvious concerns.
78-83: Highlight code line style changes.
Adjusting .docusaurus-highlight-code-line to use rgb(72, 77, 91) is consistent. Double-check that you haven't inadvertently masked any syntax highlighting tokens in certain themes.
|
This PR needs to be closed. The source and target PR branches are the same. This means that our reviewers will not be able to checkout the changes and test on their systems using this methodology which will cause a rejection error: Please follow these steps:
Closing |
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 ( simple css improvements )
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
The changes have been done for cross-browser compatibility.
Have you read the contributing guide?
Yes
Summary by CodeRabbit
Documentation
Style
Chores