Skip to content

docs: fix broken links to Readthedocs in example descriptions#2757

Merged
tpike3 merged 8 commits intomesa:mainfrom
reyan-singh:fix-readthedocs-pages-broken-links-with-latest/examples.html
Apr 25, 2025
Merged

docs: fix broken links to Readthedocs in example descriptions#2757
tpike3 merged 8 commits intomesa:mainfrom
reyan-singh:fix-readthedocs-pages-broken-links-with-latest/examples.html

Conversation

@reyan-singh
Copy link
Copy Markdown
Contributor

@reyan-singh reyan-singh commented Apr 17, 2025

There are many links in https://mesa.readthedocs.io pages which are broken or outdated and need to be fixed with latest example page https://mesa.readthedocs.io/ for smooth user experience

@tpike3 opened this PR for your review

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 17, 2025 •
edited
Loading

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

@Sahil-Chhoker Sahil-Chhoker requested a review from tpike3 April 17, 2025 17:03
Sahil-Chhoker
Sahil-Chhoker requested changes Apr 17, 2025
View reviewed changes
Copy link
Copy Markdown
Collaborator

@Sahil-Chhoker Sahil-Chhoker left a comment

Choose a reason for hiding this comment

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

@reyan-singh, It seems you are confused about the links to be put into the docs, I have left some review comments, you can start by following them.

@colinfrisch can you maybe review this PR and check if there is something missing.

colinfrisch
colinfrisch requested changes Apr 18, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@colinfrisch colinfrisch left a comment

Choose a reason for hiding this comment

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

It seems that you changed every link here to a link towards mesa examples. I think that the idea was to change the path so it redirected them correctly, not to point every missing link to the examples. From what I've seen, @Sahil-Chhoker pointed out every link that should be changed. I'll gladly review the changes when you commit the new links :)

@reyan-singh
docs updated as per review
14bf910 
docs  updated as per review
@reyan-singh
Copy link
Copy Markdown
Contributor Author

reyan-singh commented Apr 18, 2025

document fix's are updated

Sahil-Chhoker
Sahil-Chhoker reviewed Apr 18, 2025
View reviewed changes
@reyan-singh
updated repo link
355beac 
updated repo link
colinfrisch
colinfrisch approved these changes Apr 18, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@colinfrisch colinfrisch left a comment •
edited
Loading

Choose a reason for hiding this comment

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

All the links are now working and to the exception of the one I just reviewed, seem coherent. I'm approving the PR and leaving the merge to @tpike3.

@colinfrisch colinfrisch self-requested a review April 18, 2025 14:31
Sahil-Chhoker
Sahil-Chhoker reviewed Apr 18, 2025
View reviewed changes
Copy link
Copy Markdown
Collaborator

@Sahil-Chhoker Sahil-Chhoker left a comment

Choose a reason for hiding this comment

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

@tpike3 this PR can be merged!

colinfrisch
colinfrisch approved these changes Apr 19, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@colinfrisch colinfrisch left a comment

Choose a reason for hiding this comment

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

All good for me !

tpike3
tpike3 reviewed Apr 19, 2025
View reviewed changes
tpike3
tpike3 requested changes Apr 19, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@tpike3 tpike3 left a comment

Choose a reason for hiding this comment

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

@reyan-singh Thank you for doing this. Going through I realized there is still a lot of artifacts from Mesa 2 (and earlier).

I made comments throughout, would you be able to clean those up as well?

Please let me know. If not I will merge this and then do another PR to clean those up.

Thanks

@reyan-singh
Copy link
Copy Markdown
Contributor Author

reyan-singh commented Apr 19, 2025

@reyan-singh Thank you for doing this. Going through I realized there is still a lot of artifacts from Mesa 2 (and earlier).

I made comments throughout, would you be able to clean those up as well?

Please let me know. If not I will merge this and then do another PR to clean those up.

Thanks

@tpike3 I can make changes in the same PR. Thanks

@tpike3
Copy link
Copy Markdown
Member

tpike3 commented Apr 19, 2025

@reyan-singh Thank you for doing this. Going through I realized there is still a lot of artifacts from Mesa 2 (and earlier).
I made comments throughout, would you be able to clean those up as well?
Please let me know. If not I will merge this and then do another PR to clean those up.
Thanks

@tpike3 I can make changes in the same PR. Thanks

Thank you!

@reyan-singh
updated examples readme as per review
04c0612 
updated examples readme as per review
tpike3
tpike3 reviewed Apr 22, 2025
View reviewed changes
tpike3
tpike3 reviewed Apr 22, 2025
View reviewed changes
@tpike3
Copy link
Copy Markdown
Member

tpike3 commented Apr 22, 2025

Thanks @reyan-singh, I had two requests. We really appreciating you doing this, this had been needed for awhile.

@reyan-singh
updated doc as per review
02e3e49 
updated doc as per review
@reyan-singh
Copy link
Copy Markdown
Contributor Author

reyan-singh commented Apr 22, 2025

Thanks @reyan-singh, I had two requests. We really appreciating you doing this, this had been needed for awhile.

sure @tpike3, I have resolved both and also two quick observations:

  1. In schelling readme page there is section "How to Run without the GUI" do this is required anymore ?
  2. In pd_grid readme page, "How to run" section is not consistent and showing 2 ways to run solara - using web and jupyter, do this looks ok or this should be consistent with other readmr

@tpike3
Copy link
Copy Markdown
Member

tpike3 commented Apr 23, 2025

Thanks @reyan-singh, I had two requests. We really appreciating you doing this, this had been needed for awhile.

sure @tpike3, I have resolved both and also two quick observations:

  1. In schelling readme page there is section "How to Run without the GUI" do this is required anymore ?
  2. In pd_grid readme page, "How to run" section is not consistent and showing 2 ways to run solara - using web and jupyter, do this looks ok or this should be consistent with other readmr

@reyan-singh -- I would say lets stick with the principle of least surprise and make them as similar as possible.

reyan-singh and others added 3 commits April 24, 2025 14:57
@reyan-singh
Merge branch 'projectmesa:main' into fix-readthedocs-pages-broken-lin…
ecc656a 
…ks-with-latest/examples.html
@reyan-singh
udpated remaining readme
17627d3 
udpated remaining readme to make changes consistent with all other examples
@reyan-singh
updated further reading section
30ea8d5 
updated additional Resources to further reading section to make it look similar with all other examples
@reyan-singh
Copy link
Copy Markdown
Contributor Author

reyan-singh commented Apr 24, 2025

Thanks @reyan-singh, I had two requests. We really appreciating you doing this, this had been needed for awhile.

sure @tpike3, I have resolved both and also two quick observations:

  1. In schelling readme page there is section "How to Run without the GUI" do this is required anymore ?
  2. In pd_grid readme page, "How to run" section is not consistent and showing 2 ways to run solara - using web and jupyter, do this looks ok or this should be consistent with other readmr

@reyan-singh -- I would say lets stick with the principle of least surprise and make them as similar as possible.

@tpike3 done the changes in few other files to make changes consistent with other examples

Thanks @reyan-singh, I had two requests. We really appreciating you doing this, this had been needed for awhile.

sure @tpike3, I have resolved both and also two quick observations:

  1. In schelling readme page there is section "How to Run without the GUI" do this is required anymore ?
  2. In pd_grid readme page, "How to run" section is not consistent and showing 2 ways to run solara - using web and jupyter, do this looks ok or this should be consistent with other readmr

@reyan-singh -- I would say lets stick with the principle of least surprise and make them as similar as possible.

@tpike3 done the changes in few other files also to make changes consistent with other examples

@EwoutH
Copy link
Copy Markdown
Member

EwoutH commented Apr 25, 2025

What's the status of this PR? I would like to include it in the 3.2.0 release.

tpike3
tpike3 approved these changes Apr 25, 2025
View reviewed changes
Copy link
Copy Markdown
Member

@tpike3 tpike3 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thanks @reyan-singh! This is great and has been needed for some time!

@tpike3 tpike3 merged commit 1389837 into mesa:main Apr 25, 2025
3 checks passed
@tpike3
Copy link
Copy Markdown
Member

tpike3 commented Apr 25, 2025

What's the status of this PR? I would like to include it in the 3.2.0 release.

Merged!

@EwoutH
Copy link
Copy Markdown
Member

EwoutH commented Apr 25, 2025

Awesome!

(please don't forget to check if a PR has a release notes label for before merging)

@EwoutH EwoutH added the docs Release notes label label Apr 25, 2025
@EwoutH EwoutH changed the title fix readthedocs pages broken links with latest/examples.html docs: fix broken links to Readthedocs in example descriptions Apr 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@colinfrisch colinfrisch colinfrisch approved these changes

@tpike3 tpike3 tpike3 approved these changes

@Sahil-Chhoker Sahil-Chhoker Sahil-Chhoker approved these changes

Assignees

No one assigned

Labels

docs Release notes label

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@reyan-singh @tpike3 @EwoutH @colinfrisch @Sahil-Chhoker