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

Improvements suggested by Bytetec #161

Merged
merged 8 commits into from
Sep 29, 2023
Merged

Improvements suggested by Bytetec #161

merged 8 commits into from
Sep 29, 2023

Conversation

Robadob
Copy link
Member

@Robadob Robadob commented Sep 8, 2023

Where do I place the setAgentOutput? Some hints would be nice. (Agent Functions::Agent Birth & Death::Enabling Agent Birth)

The code snippets and the code summery do not fit together. Sometimes it is a model with 2 dimensions, sometimes one with 3 dimensions. (Tutorial)

  • Removed z agent variable from throughout tutorial, and tested it still works (a17ebf6)

How is a HostFunction called / started by an agent? (Agent Functions or Hosts Function & Conditions)

  • Added greater detail regarding launching host functions (cce0eb5)

Move text about new FLAMEGPU2 functionality of environment macro properties to the Defining Macro Properties section. (Environmental Properties)

  • Moved the introduction as suggested, and left a short introduction in the original location. (ecee8db)

What is a submodel and how is it used? Especially comparing with layers. (Defining Execution Order::Submodels)

  • Added more detail/example of submodel (1067213)

Some kind of overview or graphic how the different components like model, agents, functions, submodels and execution order interact with each other. (User Guide)

  • Added diagram and synopsis to explain model structure (ab64e9c)
Preview

image

Closes #158

@Robadob Robadob changed the title Remove redundant z variable from tutorial. Improvements suggested by Bytetec Sep 8, 2023
@Robadob

This comment was marked as resolved.

@mondus
Copy link
Member

mondus commented Sep 22, 2023

Mermaid +1

@Robadob Robadob force-pushed the bytetec_changes branch 2 times, most recently from 5a73f2a to f9ba86e Compare September 26, 2023 09:57
The plugin was failing to include the JS automatically, so manually set static js to CDN.

Enable mermaid's neutral theme
@Robadob
Copy link
Member Author

Robadob commented Sep 26, 2023

It's possible to style individual nodes, but I haven't bothered.

@Robadob Robadob marked this pull request as ready for review September 26, 2023 10:04
@Robadob Robadob self-assigned this Sep 26, 2023
@Robadob Robadob added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 26, 2023
Reordering message/agent seems to have fixed the overlap (or maybe its just page width).
@mondus mondus merged commit cd3aed1 into master Sep 29, 2023
5 checks passed
@mondus mondus deleted the bytetec_changes branch September 29, 2023 10:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Beginner's feedback for improving documentation
3 participants