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

Missing Documentation #66

Open
Rudde opened this issue May 31, 2022 · 4 comments
Open

Missing Documentation #66

Rudde opened this issue May 31, 2022 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Rudde
Copy link

Rudde commented May 31, 2022

I feel intimidated by Ć since there is very weak documentation on how to get started with it. The ci.md language reference is very limited, and with no syntax highlighter it hard to "feel out" what one can and can't do. I'm really missing something like a w3schools like introduction to the language to get started. Are there any plans for this, or something else?

@pfusik
Copy link
Collaborator

pfusik commented May 31, 2022

Yes, a tutorial is definitely needed! As for syntax highlighting, C# syntax highligting works well for me.

I want to work on both documenation and editor support (maybe even code navigation and completion). Which one do you consider more important as a newcomer?

@Rudde
Copy link
Author

Rudde commented May 31, 2022

Without proper documentation and layout of what is possible in the language it's very hard to get started, with or without syntax highlighting. Started my days with PHP in MS Notepad, so SH is nice, but not required to code.

@pfusik pfusik self-assigned this Nov 11, 2022
pfusik added a commit that referenced this issue Nov 15, 2022
@pfusik
Copy link
Collaborator

pfusik commented Nov 15, 2022

See https://github.com/pfusik/cito/blob/master/doc/getting-started.md and let me know your comments!

I also plan to split the reference into a language tour and an easy-to-navigate reference of classes and methods.

@pfusik pfusik added the documentation Improvements or additions to documentation label Aug 13, 2023
@pfusik
Copy link
Collaborator

pfusik commented Jul 16, 2024

Much happened during these two years. Ć is now called Fusion, it is much more mature, self-hosted, runs natively and in a browser, has VSCode / Visual Studio / Vim plugins.
Extending beginner-friendly documentation becomes a priority.

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

No branches or pull requests

2 participants