search

janet-lang / jpm

Janet Project Manager
MIT License
70 stars 22 forks source link

Add documentation to generated mendoza files #58

Closed pepe closed 1 year ago

pepe commented 2 years ago

In my opinion, as jpm matures, it would be great to add more documentation to the content/ folder, as in other projects (mendoza, jhydro ..). At least transplant and expand the index with the information we already have at https://janet-lang.org/docs/jpm.html and in README.md of this repository.

Then I would like to document cgen. I see it as one of the undiscovered gems in our ecosystem, which needs mostly more eyes and hands to get polished.

Please let me know if it sounds reasonable to you @bakpakin.

Techcable commented 2 years ago

Yes please!

I did not know about cgen until just recently 😄

I would love to help contributing to docs, as I think that's one of the most important things the project needs....

sogaiu commented 1 year ago

It looks like in the 1.25.1 [1] version of the docs, there are some more detailed jpm docs (including some cgen bits).

@pepe Is this close to what you had in mind originally?

[1] According to the CHANGELOG, Janet 1.25.1 came out in 2022-10.

pepe commented 1 year ago

Thanks. I am sorry, but ATM I am out of the loop. Or on really far orbit. Do you think I should close this?

sogaiu commented 1 year ago

The original posting has:

At least transplant and expand the index with the information we already have at https://janet-lang.org/docs/jpm.html and in README.md of this repository.

Was curious whether you think the current state is close to this.

pepe commented 1 year ago

Thank you, I will look into it a little bit deeper on Thu.