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 #1259

Open
mwestphal opened this issue Feb 4, 2024 · 0 comments
Open

Improve Quickstart guide #1259

mwestphal opened this issue Feb 4, 2024 · 0 comments
Labels
help wanted Please help with this issue! type:documentation Improvements or additions to documentation
Milestone
2.5.0

Comments

@mwestphal
Copy link
Contributor

Context
F3D has a very short quick start guide for users that is split in two.
First is this sections in readme: https://f3d.app/#quickstart
Second is the paragraph in usage: https://f3d.app/doc/user/USAGE.html#usage
It would be good to expand that into its own Quick Start guide wile still keeping a very short one in the readme with links to the new page.

Suggested solution

  • Add a QuickStart page to the usage doc
  • Rework the current doc to fir into it
  • Add link wherever needed

Skills

  • Markdown
@mwestphal mwestphal added type:documentation Improvements or additions to documentation help wanted Please help with this issue! labels Feb 4, 2024
@mwestphal mwestphal mentioned this issue Feb 4, 2024
Closed
@mwestphal mwestphal added this to the 2.4.0 milestone Feb 4, 2024
@mwestphal mwestphal modified the milestones: 2.4.0, 2.5.0 Apr 4, 2024
@mwestphal mwestphal mentioned this issue Apr 4, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted Please help with this issue! type:documentation Improvements or additions to documentation
Projects
F3D
Status: To do
Milestone
2.5.0
Development

No branches or pull requests
1 participant
@mwestphal