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 getting started documentation #175

Closed
pleonex opened this issue Dec 5, 2021 · 0 comments · Fixed by #192
Closed

Improve getting started documentation #175

pleonex opened this issue Dec 5, 2021 · 0 comments · Fixed by #192
Assignees
Milestone

Comments

@pleonex
Copy link
Member

pleonex commented Dec 5, 2021

Is your feature request related to a problem? Please describe.
The current documentation can be hard to understand, especially for beginners. We should improve it and structure better.

Describe the solution you'd like
Divide the documentation in several files / topics and explain the proposed architecture. The goal is that developers understand the architecture Yarhl propose, so later the APIs makes more sense.
It would be good to divide each API and include code snippets by topics (binary, nodes, formats). And how it relates with plugins and other tools like SceneGate.
Also change the template so the web looks better and not that old.

Describe alternatives you've considered
Move to other docuementation generators but they lack features or only run on Windows.

@pleonex pleonex added this to the Future milestone Dec 5, 2021
@pleonex pleonex self-assigned this Dec 5, 2021
@pleonex pleonex modified the milestones: Future, vNext Jan 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant