MarkBind Template for CS2103/Software Documentation

[itsyme]

Please confirm that you have searched existing issues in the repo

Yes, I have searched the existing issues

Any related issues?

No response

What is the area that this feature belongs to?

Author Usability

Is your feature request related to a problem? Please describe.

There is no large incentive for CS2103 users to use MarkBind over the default option

Describe the solution you'd like

A template for CS2103 students to use for their team project would incentivise users to use MarkBind over the default option as there is something for users to start with that is catered to this specific use case.

Use the existing template already created.
User should be able to call markbind init --template cs2103 to create this template

Describe alternatives you've considered

Possible to generalise to a more generic documentation template. We could base it off CS2103 and name it something like Software Documentation as it may seem odd to non-NUS users which could possibly put them off using MarkBind.

Additional context

No response

[damithc]

@itsyme CS2103 students are given a MarkBind version of the AB3 website (work done by @tlylt ). It is in a separate branch in AB3. Just need to merge it to master branch. https://nus-cs2103-ay2324s1.github.io/website/admin/appendixE-gitHub.html#markbind

[itsyme]

@itsyme CS2103 students are given a MarkBind version of the AB3 website (work done by @tlylt ). It is in a separate branch in AB3. Just need to merge it to master branch. https://nus-cs2103-ay2324s1.github.io/website/admin/appendixE-gitHub.html#markbind

Ahh I see thanks for the clarification prof!

[yucheng11122017]

Please also finish off #2072 if you are finishing this issue :)

[lhw-1]

Here is the link to the deployment repository that needs to be referenced.

[KevinEyo1]

Can I take this issue?

[lhw-1]

In terms of the template itself, I think we can refer to it as the AB3 template instead of the CS2103 template (and the command will be markbind init --template ab3 accordingly) - AB3 is part of the SE-EDU initiative which MarkBind falls under, whereas CS2103 is NUS-specific and may seem odd to non-NUS users as @itsyme pointed out.

In terms of the general software documentation, I think we can consider this as a separate issue, since it would require more research into what would constitute a minimal yet useful set of features for general software documentation. It would also be good to refer to what other tools (E.g. Jekyll, Docusaurus, etc.) have in place for this (if any).

So perhaps for this issue #2384, we can reduce the scope to just focus on the ab3 template 👍

[KevinEyo1]

Do I need to setup repos on MarkBind for this template to link to Netlify, based on what is done for the default and minimal template?

[tlylt]

Do I need to setup repos on MarkBind for this template to link to Netlify, based on what is done for the default and minimal template?

Can probably create one in your personal account first. Once everything is settled it can be easily transferred over.

[kaixin-hc]

Summarising progress - we now have a template for software project documentation (#2400). We can consider closing this issue, or more clearly outlining how we want to support the cs2103 usecase