f3d icon indicating copy to clipboard operation
f3d copied to clipboard

Improve quickstart guide

Open stepperpig opened this issue 1 year ago • 8 comments

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?

stepperpig avatar Aug 13 '24 21:08 stepperpig

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

mwestphal avatar Aug 14 '24 08:08 mwestphal

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 96.90%. Comparing base (38054ab) to head (447ab48). Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1563   +/-   ##
=======================================
  Coverage   96.90%   96.90%           
=======================================
  Files         105      105           
  Lines        8629     8629           
=======================================
  Hits         8362     8362           
  Misses        267      267           

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Aug 19 '24 23:08 codecov[bot]

@stepperpig please resolve discussions that you adressed.

mwestphal avatar Sep 07 '24 05:09 mwestphal

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

mwestphal avatar Oct 01 '24 18:10 mwestphal

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

sounds good!

stepperpig avatar Oct 01 '24 18:10 stepperpig

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 :)

mwestphal avatar Oct 02 '24 07:10 mwestphal

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 :)

I'm up for it

stepperpig avatar Oct 11 '24 17:10 stepperpig

Nice!

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 :)

I'm up for it

You need to rebase on the latest master and finish it up then :)

mwestphal avatar Oct 12 '24 07:10 mwestphal

I've rebased and addressed all the changes. Unless there's anything else...? Let me know.

stepperpig avatar Oct 23 '24 22:10 stepperpig

Thanks a lot @stepperpig !

mwestphal avatar Oct 24 '24 06:10 mwestphal