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: Split off the overview page, extend with spaces/activation #2673

Merged
merged 3 commits into from
Feb 10, 2025

Conversation

EwoutH
Copy link
Member

@EwoutH EwoutH commented Feb 9, 2025

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:

  • a2e38b9 to split off the overview to a separate page
  • f59fa99 to add space and time advancement sections to overview

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.

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.
@EwoutH EwoutH added the docs Release notes label label Feb 9, 2025
@EwoutH EwoutH requested review from jackiekazil and quaquel February 9, 2025 09:06
EwoutH and others added 2 commits February 9, 2025 10:12
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.
@EwoutH EwoutH changed the title docs: Split off the overview to a separate page docs: Split off the overview to a separate page, extend with spaces/activation Feb 9, 2025
@EwoutH EwoutH changed the title docs: Split off the overview to a separate page, extend with spaces/activation docs: Split off the overview page, extend with spaces/activation Feb 9, 2025
@EwoutH EwoutH marked this pull request as ready for review February 9, 2025 09:15
@EwoutH EwoutH mentioned this pull request Feb 9, 2025
41 tasks
Copy link
Member

@quaquel quaquel left a comment

Choose a reason for hiding this comment

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

Fine with me.

At what point do we remove the migration guide from the top bar?

@EwoutH EwoutH requested a review from jofmi February 10, 2025 11:43
@EwoutH EwoutH merged commit 09cfde8 into projectmesa:main Feb 10, 2025
2 checks passed
@EwoutH EwoutH deleted the mesa_overview branch February 10, 2025 19:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Release notes label
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants