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

Improve quickstart guide #1563

Open
wants to merge 26 commits into
base: master
Choose a base branch
from
Open

Improve quickstart guide #1563

wants to merge 26 commits into from

Conversation

stepperpig
Copy link

@stepperpig stepperpig commented Aug 13, 2024 •
edited
Loading

Fixes issue #1259

Changes:

  • Renamed page title from "Usage" to "Quickstart Guide".
  • Added short introduction.
  • Added "Prerequisites" section.
  • Added "Run F3D" section and added quickstart section from README file.
  • Reformatted supported file formats into table including scene and animation support.
  • Improved style in "Animations" and "Plugins" sections.
  • Added "Further Reading" section with links to other user documentation pages.

Potential Suggestions:

  • Rename the "Usage" page to "Quickstart"? Maybe duplicitous as we have this already in the README file?

mwestphal
mwestphal reviewed Aug 14, 2024
View reviewed changes
doc/user/USAGE.md Outdated Show resolved Hide resolved
@mwestphal
Copy link
Contributor

Thanks for your contribution @stepperpig ! Ill review thourougly when I can :)

mwestphal
mwestphal reviewed Aug 15, 2024
View reviewed changes
README.md Outdated Show resolved Hide resolved
mwestphal
mwestphal reviewed Aug 15, 2024
View reviewed changes
doc/user/USAGE.md Outdated Show resolved Hide resolved
mwestphal
mwestphal reviewed Aug 15, 2024
View reviewed changes
doc/user/USAGE.md Outdated Show resolved Hide resolved
mwestphal
mwestphal reviewed Aug 15, 2024
View reviewed changes
doc/user/USAGE.md Outdated Show resolved Hide resolved
mwestphal
mwestphal reviewed Aug 15, 2024
View reviewed changes
doc/user/USAGE.md Outdated Show resolved Hide resolved
mwestphal
mwestphal reviewed Aug 15, 2024
View reviewed changes
doc/user/USAGE.md Outdated Show resolved Hide resolved
mwestphal
mwestphal reviewed Aug 15, 2024
View reviewed changes
doc/user/USAGE.md Outdated Show resolved Hide resolved
mwestphal
mwestphal reviewed Aug 15, 2024
View reviewed changes
doc/user/USAGE.md Outdated Show resolved Hide resolved
mwestphal
mwestphal reviewed Aug 15, 2024
View reviewed changes
doc/user/USAGE.md Outdated Show resolved Hide resolved
mwestphal
mwestphal reviewed Aug 15, 2024
View reviewed changes
doc/user/USAGE.md Outdated Show resolved Hide resolved
mwestphal
mwestphal reviewed Aug 15, 2024
View reviewed changes
doc/user/USAGE.md Outdated Show resolved Hide resolved
mwestphal
mwestphal reviewed Aug 15, 2024
View reviewed changes
doc/user/USAGE.md Outdated Show resolved Hide resolved
mwestphal
mwestphal reviewed Aug 15, 2024
View reviewed changes
doc/user/USAGE.md Outdated Show resolved Hide resolved
mwestphal
mwestphal reviewed Aug 15, 2024
View reviewed changes
doc/user/USAGE.md Outdated Show resolved Hide resolved
mwestphal
mwestphal reviewed Aug 15, 2024
View reviewed changes
doc/user/USAGE.md Outdated Show resolved Hide resolved
mwestphal
mwestphal requested changes Aug 15, 2024
View reviewed changes
Copy link
Contributor

@mwestphal mwestphal left a comment

Choose a reason for hiding this comment

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

Nice work, a few changes needed and some precision asked.

@codecov Codecov
Copy link

codecov bot commented Aug 19, 2024 •
edited
Loading

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.84%. Comparing base (fe2e432) to head (ca64d79).

Additional details and impacted files 
@@           Coverage Diff           @@
##           master    #1563   +/-   ##
=======================================
  Coverage   96.84%   96.84%           
=======================================
  Files         108      108           
  Lines        7671     7671           
=======================================
  Hits         7429     7429           
  Misses        242      242

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

mwestphal
mwestphal reviewed Aug 20, 2024
View reviewed changes
doc/CHANGELOG.md Outdated Show resolved Hide resolved
mwestphal
mwestphal reviewed Aug 20, 2024
View reviewed changes
doc/user/QUICKSTART.md Outdated Show resolved Hide resolved
mwestphal
mwestphal reviewed Aug 20, 2024
View reviewed changes
doc/user/QUICKSTART.md Outdated Show resolved Hide resolved
mwestphal
mwestphal reviewed Aug 24, 2024
View reviewed changes
_sass/.DS_Store Outdated Show resolved Hide resolved
mwestphal
mwestphal reviewed Aug 24, 2024
View reviewed changes
application/.DS_Store Outdated Show resolved Hide resolved
mwestphal
mwestphal reviewed Aug 24, 2024
View reviewed changes
doc/user/PLUGINS.md Outdated Show resolved Hide resolved
mwestphal
mwestphal reviewed Aug 24, 2024
View reviewed changes
doc/user/QUICKSTART.md Outdated Show resolved Hide resolved
stepperpig and others added 26 commits September 25, 2024 17:50
@stepperpig @kli332
restructured formats to table
9db8298
@stepperpig @kli332
scene construction section edits
f01357a
@stepperpig @kli332
added abstract, prereqs, reformatted run section
af13be9
@stepperpig @kli332
edit remaining sections
834b268
@stepperpig @kli332
animation support table column added
e07fa72
@stepperpig @kli332
added further reading section
19e5c34
@stepperpig @kli332
updated changelog
7139a01
@stepperpig @kli332
linked to user doc quickstart guide
f20fbeb
@stepperpig @kli332
minor rewording, added interactions section
ee46847
@stepperpig @kli332
restructured animations section
1d66dc6
@stepperpig @kli332
wording fix
d2e6fe5
@stepperpig @kli332
renamed from 'usage' to 'quickstart'
ff76fd8
@stepperpig @kli332
added dedicated supported formats page
1f0dcce
@stepperpig @kli332
added shortened list for supported file formats
9e2b7a4
@stepperpig @kli332
plugin usage example
c1a0f77
@stepperpig @kli332
supported plugins section updated
283e9d1
@stepperpig @kli332
added dedicated plugins section
3deb134
@stepperpig @kli332
minor fix
ca18bec
@stepperpig @kli332
deleted redundant files
3be7c54 
removed .DS_Store file
@stepperpig @kli332
shortened animation section
fa75651
@stepperpig @kli332
plugin example updated
fc065cb
@stepperpig @kli332
shortened README qs
eba1d2e 
shortened README qs
@stepperpig @kli332
running f3d section fix
e50f7f5
@stepperpig @kli332
typo fix, added format table plugins
b79ea8f
@kli332
short quickstart small edit
7777b01
@kli332
removed help line
ca64d79
@mwestphal
Copy link
Contributor

You still around @stepperpig ? This one is close to be merged :)

@stepperpig
Copy link
Author

You still around @stepperpig ? This one is close to be merged :)

sounds good!

@mwestphal
Copy link
Contributor

You still around @stepperpig ? This one is close to be merged :)

sounds good!

What I mean is that its still need a bit of work if you are up for it :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mwestphal mwestphal mwestphal requested changes

@Meakk Meakk Awaiting requested review from Meakk

Requested changes must be addressed to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@stepperpig @mwestphal @Meakk @kli332