Revamp documentation content and navigation #190

adamamer20 · 2025-12-08T23:04:56Z

Enhance the documentation structure and content for better clarity and usability. This includes updates to navigation, improved API references, and additional examples for key components. The changes aim to provide a more comprehensive and user-friendly experience for developers.

codecov · 2025-12-08T23:06:18Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.28%. Comparing base (29fa011) to head (647f5c7).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #190      +/-   ##
==========================================
+ Coverage   89.23%   89.28%   +0.04%     
==========================================
  Files          14       14              
  Lines        2007     2007              
==========================================
+ Hits         1791     1792       +1     
+ Misses        216      215       -1

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

mkdocs.yml

docs/general/tutorials/2_introductory_tutorial.py

adamamer20 · 2025-12-08T23:08:42Z

@coderabbitai review

coderabbitai · 2025-12-08T23:08:58Z

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

coderabbitai · 2025-12-08T23:09:03Z

Warning

Rate limit exceeded

@adamamer20 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 28 minutes and 20 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between 3037456 and 69e407a.

⛔ Files ignored due to path filters (3)

docs/general/plots/boltzmann.svg is excluded by !**/*.svg
docs/general/plots/sugarscape.svg is excluded by !**/*.svg
uv.lock is excluded by !**/*.lock

📒 Files selected for processing (18)

.gitignore (1 hunks)
CHANGELOG.md (1 hunks)
CONTRIBUTING.md (4 hunks)
README.md (1 hunks)
ROADMAP.md (1 hunks)
docs/api/conf.py (4 hunks)
docs/api/index.rst (1 hunks)
docs/api/reference/agents/index.rst (1 hunks)
docs/api/reference/datacollector.rst (1 hunks)
docs/api/reference/model.rst (1 hunks)
docs/api/reference/space/index.rst (1 hunks)
docs/general/changelog.md (1 hunks)
docs/general/index.md (1 hunks)
docs/general/tutorials/2_introductory_tutorial.py (1 hunks)
docs/general/tutorials/4_datacollector.py (1 hunks)
docs/general/user-guide/0_getting-started.md (5 hunks)
mkdocs.yml (4 hunks)
pyproject.toml (1 hunks)

Note

Other AI code review bot(s) detected

CodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review.

✨ Finishing touches

📝 Generate docstrings

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch split/docs-and-toptexts

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

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Ben-geo · 2025-12-14T17:22:58Z

@adamamer20 there are a few conflicts
also what is the CHANGELOG.md for it is an older version right?

…o split/docs-and-toptexts

github-actions · 2025-12-18T07:57:20Z

Docs preview ready for PR #190.

https://mesa.github.io/mesa-frames/preview/split/docs-and-toptexts/0e0cf11/

…steps

…nchmarks

…ance - Updated Sugarscape model to use direct property access for empty and full cells, reducing unnecessary joins. - Enhanced AntDFBase agent's eat method to optimize sugar harvesting by joining agent positions with cell properties directly. - Introduced cell_properties property in AbstractDiscreteSpace to provide direct access to cell attributes without agent occupancy. - Implemented get_cell_properties method for efficient retrieval of cell properties at specified coordinates. - Improved AbstractAgentSet's handling of agent indices to ensure proper DataFrame structure and maintain order. - Enhanced Grid class to support efficient neighborhood retrieval and cell property management, including dense row-major optimizations. - Added tests for get/set cell property functionality in both dense and toroidal grid configurations to ensure correctness and robustness.

github-actions · 2025-12-19T08:32:41Z

Docs preview ready for PR #190.

https://mesa.github.io/mesa-frames/preview/split/docs-and-toptexts/b245f60/

for more information, see https://pre-commit.ci

github-actions · 2025-12-19T09:44:39Z

Docs preview ready for PR #190.

https://mesa.github.io/mesa-frames/preview/split/docs-and-toptexts/221385d/

github-actions · 2025-12-19T09:44:51Z

Docs preview ready for PR #190.

https://mesa.github.io/mesa-frames/preview/split/docs-and-toptexts/a50a9fa/

…esa/mesa-frames into split/docs-and-toptexts

github-actions · 2025-12-19T10:40:26Z

Docs preview ready for PR #190.

https://mesa.github.io/mesa-frames/preview/split/docs-and-toptexts/37670c9/

Ben-geo

I haven't gone line by line for space

but the rest looks good

CHANGELOG.md

github-actions · 2025-12-21T08:39:44Z

Docs preview ready for PR #190.

https://mesa.github.io/mesa-frames/preview/split/docs-and-toptexts/aa09f63/

github-actions · 2025-12-21T08:55:35Z

Docs preview ready for PR #190.

https://mesa.github.io/mesa-frames/preview/split/docs-and-toptexts/647f5c7/

Revamp documentation content and navigation

69e407a

adamamer20 mentioned this pull request Dec 8, 2025

[Documentation]: Adding advanced tutorial and improvements to documentation #179

Closed

chatgpt-codex-connector bot reviewed Dec 8, 2025

View reviewed changes

mkdocs.yml Show resolved Hide resolved

docs/general/tutorials/2_introductory_tutorial.py Outdated Show resolved Hide resolved

adamamer20 self-assigned this Dec 8, 2025

adamamer20 added the docs Improvements or additions to documentation label Dec 8, 2025

adamamer20 added this to the 0.2.0 milestone Dec 8, 2025

adamamer20 requested review from Ben-geo and EwoutH December 8, 2025 23:29

adamamer20 added 3 commits December 16, 2025 20:25

Merge branch 'main' of https://github.com/projectmesa/mesa-frames int…

ae64f6e

…o split/docs-and-toptexts

Merge branch 'main' of https://github.com/projectmesa/mesa-frames int…

3880b04

…o split/docs-and-toptexts

update uv.lock

0e0cf11

adamamer20 added 6 commits December 18, 2025 09:04

Fix trigger condition in MoneyModel to use steps instead of schedule.…

7dc254c

…steps

Enable notebook execution in mkdocs configuration

37c3603

Refactor CLI model and agent options to use single string type

5bfcd8f

Remove outdated documentation files for DataCollector tutorial and be…

7ba15fc

…nchmarks

Add theme-aware image swapping and benchmark plots to documentation

b245f60

adamamer20 and others added 3 commits December 19, 2025 10:41

update plots

0f53f51

delete old plot

221385d

[pre-commit.ci] auto fixes from pre-commit.com hooks

a50a9fa

for more information, see https://pre-commit.ci

Fix commented installation command in Data Collector tutorial

4c8bf15

adamamer20 added 2 commits December 19, 2025 11:38

Update benchmark plot paths in README for improved organization

32b05d2

Merge branch 'split/docs-and-toptexts' of https://github.com/projectm…

37670c9

…esa/mesa-frames into split/docs-and-toptexts

Ben-geo approved these changes Dec 20, 2025

View reviewed changes

CHANGELOG.md Show resolved Hide resolved

revert changes to main

aa09f63

adamamer20 added 2 commits December 21, 2025 09:42

Update formatting in README and ROADMAP for consistency

59db978

Refactor README layout for improved readability and organization

647f5c7

adamamer20 merged commit 2a68b75 into main Dec 21, 2025
16 checks passed

adamamer20 deleted the split/docs-and-toptexts branch December 21, 2025 08:57

Revamp documentation content and navigation #190

Revamp documentation content and navigation #190

Uh oh!

Conversation

adamamer20 commented Dec 8, 2025

Uh oh!

codecov bot commented Dec 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

Uh oh!

adamamer20 commented Dec 8, 2025

Uh oh!

coderabbitai bot commented Dec 8, 2025

Uh oh!

coderabbitai bot commented Dec 8, 2025

Rate limit exceeded

Other AI code review bot(s) detected

Uh oh!

Ben-geo commented Dec 14, 2025

Uh oh!

github-actions bot commented Dec 18, 2025

Uh oh!

github-actions bot commented Dec 19, 2025

Uh oh!

github-actions bot commented Dec 19, 2025

Uh oh!

github-actions bot commented Dec 19, 2025

Uh oh!

github-actions bot commented Dec 19, 2025

Uh oh!

Ben-geo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actions bot commented Dec 21, 2025

Uh oh!

github-actions bot commented Dec 21, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

codecov bot commented Dec 8, 2025 •

edited

Loading