Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix home page rendering #2258

Merged
merged 11 commits into from
Jul 18, 2024
Merged

Conversation

njzjz
Copy link
Member

@njzjz njzjz commented Jul 18, 2024

Summary by CodeRabbit

  • Documentation

    • Reorganized sections in the HTML documentation to better highlight specific functionalities like Trajectory, Filtering, Isomers, Network, HTML5, and Fast.
  • Style

    • Simplified and adjusted layout styling by removing specific styling rules related to the .hero class for improved responsiveness.

Copy link
Contributor

coderabbitai bot commented Jul 18, 2024

Walkthrough

Walkthrough

The changes involve a reorganization of sections within an HTML documentation file to better emphasize specific functionalities, and a simplification of CSS by removing styling rules associated with the .hero class. This reorganization aims to improve clarity and accessibility of the documentation, while the CSS modifications focus on enhancing layout responsiveness.

Changes

Files Change Summary
docs/overall.md Reorganized sections to emphasize functionalities like Trajectory, Filtering, Isomers, Network, HTML5, and Fast.
docs/_static/css/custom.css Removed styling rules for the .hero class, altering text alignment, margin adjustments, image and paragraph styling, and action button styling.

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?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

codspeed-hq bot commented Jul 18, 2024

CodSpeed Performance Report

Merging #2258 will not alter performance

Comparing njzjz:docs-fix-homepage (ae8b1ca) with master (558b8a1)

Summary

✅ 8 untouched benchmarks

Copy link

codecov bot commented Jul 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.04%. Comparing base (8e22614) to head (ae8b1ca).
Report is 3 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2258      +/-   ##
==========================================
- Coverage   95.18%   95.04%   -0.14%     
==========================================
  Files          18       18              
  Lines        1432     1432              
==========================================
- Hits         1363     1361       -2     
- Misses         69       71       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Outside diff range, codebase verification and nitpick comments (1)
docs/overall.md (1)

Line range hint 47-57:
LGTM! But fix the typo in the guide section.

The guide and tutorials section is informative and well-structured. However, there is a typo in "ReacNetGenerattor".

- See [the guide](guide/index) to learn how to install and use ReacNetGenerattor.
+ See [the guide](guide/index) to learn how to install and use ReacNetGenerator.
Tools
Markdownlint

45-45: null
Bare URL used

(MD034, no-bare-urls)


45-45: null
Bare URL used

(MD034, no-bare-urls)

docs/overall.md Outdated Show resolved Hide resolved
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

docs/overall.md Show resolved Hide resolved
docs/overall.md Outdated Show resolved Hide resolved
njzjz and others added 4 commits July 17, 2024 23:37
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Signed-off-by: Jinzhe Zeng <[email protected]>
@njzjz njzjz marked this pull request as ready for review July 18, 2024 04:03
@njzjz njzjz added this pull request to the merge queue Jul 18, 2024
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Comment on lines +14 to +33
::::{grid} 1 2 3 3
:::{grid-item-card} Trajectory
Processing of MD trajectory containing atomic coordinates or bond orders

## Filtering

:::
:::{grid-item-card} Filtering
Hidden Markov Model (HMM) based noise filtering

## Isomers

Isomers identifying accoarding to SMILES

## Network

:::
:::{grid-item-card} Isomers
Isomers identifying according to SMILES
:::
:::{grid-item-card} Network
Generation of reaction network for visualization using force-directed algorithm

## HTML5

:::
:::{grid-item-card} HTML5
Showing an interactive web page

## Fast

:::
:::{grid-item-card} Fast
Parallel computing and performance optimization

</div>
:::
::::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fix the typo in the description for "Isomers".

There is a typo in the description for "Isomers".

- Isomers identifying accoarding to SMILES
+ Isomers identifying according to SMILES
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.

Suggested change
::::{grid} 1 2 3 3
:::{grid-item-card} Trajectory
Processing of MD trajectory containing atomic coordinates or bond orders
## Filtering
:::
:::{grid-item-card} Filtering
Hidden Markov Model (HMM) based noise filtering
## Isomers
Isomers identifying accoarding to SMILES
## Network
:::
:::{grid-item-card} Isomers
Isomers identifying according to SMILES
:::
:::{grid-item-card} Network
Generation of reaction network for visualization using force-directed algorithm
## HTML5
:::
:::{grid-item-card} HTML5
Showing an interactive web page
## Fast
:::
:::{grid-item-card} Fast
Parallel computing and performance optimization
</div>
:::
::::
:::{grid-item-card} Isomers
Isomers identifying according to SMILES
:::
Tools
LanguageTool

[duplication] ~21-~21: Possible typo: you repeated a word
Context: ...noise filtering ::: :::{grid-item-card} Isomers Isomers identifying according to SMILES ::: :::...

(ENGLISH_WORD_REPEAT_RULE)

Merged via the queue into deepmodeling:master with commit 92b538d Jul 18, 2024
22 checks passed
@njzjz njzjz deleted the docs-fix-homepage branch July 18, 2024 04:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant