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

Improve quickstart guide #1563

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

Conversation

stepperpig
Copy link

@stepperpig stepperpig commented Aug 13, 2024

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?

doc/user/USAGE.md Outdated Show resolved Hide resolved
@mwestphal
Copy link
Contributor

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

README.md Outdated Show resolved Hide resolved
doc/user/USAGE.md Outdated Show resolved Hide resolved
doc/user/USAGE.md Outdated Show resolved Hide resolved
doc/user/USAGE.md Outdated Show resolved Hide resolved
doc/user/USAGE.md Outdated Show resolved Hide resolved
doc/user/USAGE.md Outdated Show resolved Hide resolved
doc/user/USAGE.md Outdated Show resolved Hide resolved
doc/user/USAGE.md Outdated Show resolved Hide resolved
doc/user/USAGE.md Outdated Show resolved Hide resolved
doc/user/USAGE.md Outdated Show resolved Hide resolved
doc/user/USAGE.md Outdated Show resolved Hide resolved
doc/user/USAGE.md Outdated Show resolved Hide resolved
doc/user/USAGE.md Outdated Show resolved Hide resolved
doc/user/USAGE.md Outdated Show resolved Hide resolved
doc/user/USAGE.md Outdated Show resolved Hide resolved
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.

Copy link

codecov bot commented Aug 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.82%. Comparing base (f002d29) to head (2e8a071).
Report is 11 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1563   +/-   ##
=======================================
  Coverage   96.82%   96.82%           
=======================================
  Files         108      108           
  Lines        7643     7643           
=======================================
  Hits         7400     7400           
  Misses        243      243           

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

doc/CHANGELOG.md Outdated Show resolved Hide resolved
doc/user/QUICKSTART.md Outdated Show resolved Hide resolved
doc/user/QUICKSTART.md Outdated Show resolved Hide resolved
_sass/.DS_Store Outdated Show resolved Hide resolved
application/.DS_Store Outdated Show resolved Hide resolved
doc/user/PLUGINS.md Outdated Show resolved Hide resolved
doc/user/QUICKSTART.md Outdated Show resolved Hide resolved
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.

some changes required but good progress so far!

doc/user/PLUGINS.md Outdated Show resolved Hide resolved
f3d --help
man f3d # Linux only
```
See the [Quickstart Guide](QUICKSTART.md) for more information about getting started with F3D.
Copy link
Contributor

Choose a reason for hiding this comment

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

Im not sure I prefer this version tbh. The info is the same, just hard to get.

How about keeping just the first command in ``` ?

Copy link
Author

Choose a reason for hiding this comment

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

do you think we should keep the second command then?

also do you think we should expand the section slightly with 1-2 basic key bindings? or leave it more concise?

Copy link
Contributor

Choose a reason for hiding this comment

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

I think we should keep a single command here.

Since we now have a quick start guide, lets keep this section super short, so id say no bindings here.

@mwestphal
Copy link
Contributor

@stepperpig please resolve discussions that you adressed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants