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.

Sign up for GitHub

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

Jump to bottom

Full Userguide restructure #75

Merged
merged 1 commit into from
Apr 13, 2022
Merged

Full Userguide restructure #75

merged 1 commit into from
Apr 13, 2022

Conversation

Robadob
Copy link
Member

@Robadob Robadob commented Feb 3, 2022

@Robadob Robadob added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 3, 2022
@Robadob Robadob self-assigned this Feb 3, 2022
@Robadob Robadob force-pushed the restructure_2022 branch 2 times, most recently from 45213e5 to b28d687 Compare February 7, 2022 16:54
@Robadob

This comment was marked as outdated.

Sign in to view
@Robadob Robadob force-pushed the restructure_2022 branch 2 times, most recently from f8e4f9c to 46f6930 Compare March 10, 2022 09:49
@mondus

This comment was marked as outdated.

Sign in to view
@Robadob
Copy link
Member Author

Robadob commented Apr 7, 2022 •
edited
Loading

Remaining tasks:

  • Chapter 8: Running a simulation
  • Chapter 9: Running multiple simulations
  • Review Chapter 11: Performance troubleshooting
  • Review Chapter 12: FGPU2 Source
  • Review/Move FLAMEGPU_EXIT_CONDITON section/page.
  • Decide where to add a page/info about SEATBELTS.
  • Extend building with CMake page (screenshots and options table from README {After chatting with Pete, opted to specify refer to README as options may vary between releases})
    • We could extend the README to include the CMake GUI screenshots for completeness.
  • Test the Python RunPlanVector example in chapter9/running-multiple-simulations
  • @MILeach Dependency graph stuff?
  • Performance trouble shooting/building from source chapters might want some thought/rework.

@Robadob Robadob marked this pull request as ready for review April 8, 2022 14:59
@Robadob

This comment was marked as outdated.

Sign in to view
@Robadob
Copy link
Member Author

Robadob commented Apr 11, 2022 •
edited
Loading

Am currently doing a full read through to find/fix minor editors (e.g. dead links/typos), some more general possible suggestions

  • Splitting models across multiple files guidance (have done this in primage, and prototypes for host/agent fns in headers gets a bit awkward).
  • Some general 'advanced' RTC coverage (e.g. fact includes work, relevant environment properties) see Notes regarding RTC compilation and 3rd party headers #80

This was referenced Apr 12, 2022
Closed
Closed
Closed
Closed
Closed
Closed
Closed
@Robadob
Copy link
Member Author

Robadob commented Apr 12, 2022

Latest artefacts: https://github.com/FLAMEGPU/FLAMEGPU2-docs/suites/6090247155/artifacts/211073499

@Robadob
Full restructure and overhaul.
57b81f9 
Various edits and additions, sections have been moved about and a new tutorial using Circles2D has been introduced.
These changes follow an agreed new structure, with minor tweaks.
This closes various issues which cite the PR.
@mondus
Copy link
Member

mondus commented Apr 13, 2022

Remove the numbers in filenames

@mondus mondus merged commit a2065df into master Apr 13, 2022
@mondus mondus deleted the restructure_2022 branch April 13, 2022 14:20
@Robadob Robadob mentioned this pull request Jul 12, 2022
Closed
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ptheywood ptheywood Awaiting requested review from ptheywood

@MILeach MILeach Awaiting requested review from MILeach

@mondus mondus Awaiting requested review from mondus

Assignees

@Robadob Robadob

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@Robadob @mondus