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

Create more documentation and learning materials (like tutorial + reference) #137

Open
ghost opened this issue Aug 5, 2023 · 7 comments
Assignees
Labels
documentation Related to the project documentation

Comments

@ghost
Copy link

ghost commented Aug 5, 2023

Examples is good but i cant understand all supported methods of lua integration, etc

@xyproto xyproto self-assigned this Aug 5, 2023
@xyproto xyproto added the documentation Related to the project documentation label Aug 5, 2023
@xyproto
Copy link
Owner

xyproto commented Aug 5, 2023

Thanks for the question!

Which format would be most useful? A large Markdown file, a PDF or a static web page?

@ghost
Copy link
Author

ghost commented Aug 5, 2023

To be honest i don't know. Large md file seems be laggy (like python or matrix docs), pdf may be variant but afaik nobody uses it, and what does mean "static page"?

@xyproto
Copy link
Owner

xyproto commented Aug 5, 2023

A static web page is the opposite of dynamic. It is when a web page is more like a brochure with information and less like an application.

@ghost
Copy link
Author

ghost commented Aug 6, 2023

Okay, may be static page

@ghost ghost closed this as not planned Won't fix, can't repro, duplicate, stale Dec 4, 2023
@xyproto
Copy link
Owner

xyproto commented Dec 4, 2023

I am planning to create a PDF and/or YT videos, but life is busy. 🙂

@ghost ghost reopened this Dec 4, 2023
@xyproto xyproto changed the title question: There is an documentation/reference of al Create more documentation and learning materials (like tutorial + reference) for Algernon Dec 4, 2023
@xyproto xyproto changed the title Create more documentation and learning materials (like tutorial + reference) for Algernon Create more documentation and learning materials (like tutorial + reference) Dec 4, 2023
@xyproto
Copy link
Owner

xyproto commented Dec 15, 2023

Please test if this new tutorial is helpful:

https://github.com/xyproto/algernon/blob/main/TUTORIAL.md

@ghost
Copy link
Author

ghost commented Dec 15, 2023

at begin ok

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

No branches or pull requests

1 participant