docs: Split off the overview page, extend with spaces/activation#2673
Merged
docs: Split off the overview page, extend with spaces/activation#2673
Conversation
Based on feedback from the paper, this splits the overview (again) off to a separate page. It does add one more item to the top bar, but I think that's worth it.
Expand the Mesa overview documentation to fully cover all core features: - Add comprehensive section on spaces including grid-based, network, and Voronoi spaces, with code examples - Add section on property layers and continuous space functionality - Add new section on time advancement covering basic steps, agent activation patterns, and event-based scheduling - Include practical code examples demonstrating each feature - Maintain consistency with existing documentation style and structure This update brings the overview in line with Mesa's paper, ensuring all major features are properly documented in one place.
quaquel
approved these changes
Feb 9, 2025
Member
quaquel
left a comment
There was a problem hiding this comment.
Fine with me.
At what point do we remove the migration guide from the top bar?
EwoutH
added a commit
that referenced
this pull request
Mar 26, 2025
* docs: Split off the overview to a separate page Based on feedback from the paper, this splits the overview (again) off to a separate page. It does add one more item to the top bar, but I think that's worth it. * docs: Add space and time advancement sections to overview Expand the Mesa overview documentation to fully cover all core features: - Add comprehensive section on spaces including grid-based, network, and Voronoi spaces, with code examples - Add section on property layers and continuous space functionality - Add new section on time advancement covering basic steps, agent activation patterns, and event-based scheduling - Include practical code examples demonstrating each feature - Maintain consistency with existing documentation style and structure This update brings the overview in line with Mesa's paper, ensuring all major features are properly documented in one place.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Based on feedback from the paper, this splits the overview (again) off to a separate page. It does add one more item to the top bar, but I think that's worth it.
This PR consists of two commits:
Check out the new overview page rendered on Readthedocs: https://mesa--2673.org.readthedocs.build/2673/overview.html
Part of #2666 based on feedback of @jofmi.