write a tutorial on how to use

[theSoberSobber]

write a tut, so that I everyone can shamelessly steal use this.
write on your blog and link it if possible.

[KorigamiK]

Haha, I totally forgot about this. The plan is to release this on CTAN so you can use it directly on something like overleaf. I’ll work on it for a few additions and then update the readme soon. I’m not sure about the blog though.

[Peacesandy]

Hi i'll like to contribute to this project by writing the documentation

[KorigamiK]

Hi i'll like to contribute to this project by writing the documentation

Sorry for the late reply, GitHub is extremely deficient in handling the notifications.

But I'd be ecstatic if you're able to contribute to this project. The documentation would greatly help everyone and would be needed before publishing to CTAN.

I was hoping the docs should at least include the configuration options for this class and the general description of everything.

Anyway, I'll leave the work to you @Peacesandy 😄

[KorigamiK]

So, new updates!

We have this project published on CTAN

However we still lack the documentation for the actual usage.
The folder structure is described here

We may want to switch our .cls source code to use .dtx (documented $\LaTeX$ files)
to generate the docs from the source itself.

A good resource I found is this

[aradnix]

In advance, I congratulate you for having already published it on CTAN, that is important for us to know that it exists. I discovered this class a couple of days ago looking for the KOMA Script documentation on CTAN.

I like how it looks and what you propose, but it is time-critical to document the class because you have to review the code to guess how to use it and that is not available to all users.

That's why I came to open an issue and raise that need. I'm glad to see that I'm not the only one with this concern. So, considering what I see in this thread, I'm interested to know if I could help @Peacesandy in any way with the documentation of this class.

[Peacesandy]

Hi @aradnix we could work together on it.

[aradnix]

I like the idea, and I am pleased that you are proposing it.

How do you see the proposal for the class to dtx, do you find it useful, what do you suggest to work on the documentation?

[KorigamiK]

I like the idea, and I am pleased that you are proposing it.

How do you see the proposal for the class to dtx, do you find it useful, what do you suggest to work on the documentation?

Hi, first of all I’m glad that you an @Peacesandy are interested in documenting this class.
I suggest switching to dtx since it’s what I’ve found other classes use in the past.

Using something like ltxdoc means we can extract the documentation from the source code .dtx files.

The code itself in the .tex class however, isn’t required to be changed, it is the comments around it that create the documentation and the appropriate documentation pdf is generated.
the resource I mentioned is great and describes how to get started using it.

Please tell me if there are any questions or if you suggest an alternate way to write the docs.

Cheers 😊

[aradnix]

I like the idea, and I am pleased that you are proposing it.
How do you see the proposal for the class to dtx, do you find it useful, what do you suggest to work on the documentation?

Hi, first of all I’m glad that you an @Peacesandy are interested in documenting this class. I suggest switching to dtx since it’s what I’ve found other classes use in the past.

Using something like ltxdoc means we can extract the documentation from the source code .dtx files.

The code itself in the .tex class however, isn’t required to be changed, it is the comments around it that create the documentation and the appropriate documentation pdf is generated. the resource I mentioned is great and describes how to get started using it.

Please tell me if there are any questions or if you suggest an alternate way to write the docs.

Cheers blush

On my side, I am going to have a look at the resource that you mentioned, this may be the best way to work on it.

In the other issue, you clarified how to insert a logo on the front page. But more than a doubt, I have the feeling that it would be better to have a little better reorganisation of the code in terms of those commands that are necessary and those that are optional.

Moreover, to make the class more customisable, it would be nice to be able to change the text size, the page size, and to use the class in languages other than English without having to mess with the class code, as I had to.

I don't know if you have this in mind for future versions. But I'm saying it anyway.

[KorigamiK]

I like the idea, and I am pleased that you are proposing it.
How do you see the proposal for the class to dtx, do you find it useful, what do you suggest to work on the documentation?

Hi, first of all I’m glad that you an @Peacesandy are interested in documenting this class. I suggest switching to dtx since it’s what I’ve found other classes use in the past.

Using something like ltxdoc means we can extract the documentation from the source code .dtx files.

The code itself in the .tex class however, isn’t required to be changed, it is the comments around it that create the documentation and the appropriate documentation pdf is generated. the resource I mentioned is great and describes how to get started using it.

Please tell me if there are any questions or if you suggest an alternate way to write the docs.

Cheers blush

On my side, I am going to have a look at the resource that you mentioned, this may be the best way to work on it.

In the other issue, you clarified how to insert a logo on the front page. But more than a doubt, I have the feeling that it would be better to have a little better reorganisation of the code in terms of those commands that are necessary and those that are optional.

Moreover, to make the class more customisable, it would be nice to be able to change the text size, the page size, and to use the class in languages other than English without having to mess with the class code, as I had to.

I don't know if you have this in mind for future versions. But I'm saying it anyway.

These are indeed very needed changes, I will open separate issues on each of the features I work on.

[KorigamiK]

Please have a look at the progress so far @Peacesandy @aradnix in the new branch