search

SethBling / cbscript

CBScript for Minecraft
1.13k stars 28 forks source link

Add a documentation #10

Open FegDotExe opened 4 months ago

FegDotExe commented 4 months ago

As it stands now, the only way to get into cbscript is by reading through the provided scripts and by trial and error, at least from what I know. It would be extremely nice if a documentation about the fundamentals of the language could be added to the repo.

MattBehrens02 commented 4 months ago

Seconding this as it would be a huge help. I know this would be a huge undertaking but I can really see this being a very useful tool in the realm of datapack creation.

deli73 commented 4 months ago

strongly agreed, this needs docs of some kind. we've been wanting a tool like this for years but it's very difficult when there's no real instructions on how it works

SethBling commented 4 months ago

I'd love for there to be usage documentation, but I also would rather spend my time making videos. If anyone else wants to take a stab at it, I can help correct mistakes.

deli73 commented 4 months ago

understandable! if we can get things working we might try to work on it with some friends

MattBehrens02 commented 4 months ago

I'd be willing to pick away at things too. College does take away a lot of my free time right now but it would be a really cool project to take a part in.

phazejeff commented 4 months ago

I'd love for there to be usage documentation, but I also would rather spend my time making videos. If anyone else wants to take a stab at it, I can help correct mistakes.

Maybe make a video on general usage?

SethBling commented 4 months ago

Yeah, I suppose that's something I could do. Show some of the features used in my scripts to give people a starting place to experiment, and mention what I'm looking for in terms of GitHub contributions.

deli73 commented 4 months ago

yeah, that'd be helpful. we're struggling to figure out how some of this stuff works without clear docs

ArcticYeti commented 3 months ago

I'd love to contribute the project with docs, but unfortunately I can't due to a lack of free time as of late.

I can however suggest checking out Sphinx with the custom Furo theme for technical documentation. It's pretty easy to get the hang of and can produce some wonderful clean docs!

https://github.com/sphinx-doc/sphinx https://github.com/pradyunsg/furo

zipcord24 commented 3 months ago

agreed

AdoHTQ commented 3 months ago

Not entirely sure how this works, but you could also use a Github Wiki so that it's on the repo.

Budmeister commented 3 months ago

This is something I would also like to help with but probably won't have time for until after Spring graduation.

Maybe some generative AI would be able to help in the initial stages of figuring out the syntax.

deli73 commented 3 months ago

Maybe some generative AI would be able to help in the initial stages of figuring out the syntax.

generative AI sounds like a good way to introduce a bunch of hard-to-locate errors into the documentation, no thanks.

Remceau commented 2 months ago

Is someone already actively working on this? If not, I am going to make a start at it and see how far I can get.

Update: I have started writing documentation in a fork (https://github.com/Remceau/cbscript). if anyone wants to contribute to it, feel free to add pull requests or issues there. I will pull it to this repo as soon as basic documentation has been completed.