sddf icon indicating copy to clipboard operation
sddf copied to clipboard

docs: initial templates

Open midnightveil opened this issue 8 months ago • 3 comments

As discussed on Monday.

Related #156.

midnightveil avatar Apr 11 '25 01:04 midnightveil

I think it would be confusing for users to see empty files, I think we should add the files as we have actual docs for each class.

Ivan-Velickovic avatar Apr 11 '25 01:04 Ivan-Velickovic

I think it would be confusing for users to see empty files, I think we should add the files as we have actual docs for each class.

I thought we'd decided on Monday this was how we'd do it? Make the templates and then we have a spot to put things and then we go from there.

Like, of course having empty doc files is confusing --- but so is having no docs, so it's not really /more/ confusing.

midnightveil avatar Apr 11 '25 01:04 midnightveil

I tend to agree with @midnightveil here, plus I am working on filling some of these in now...

Courtney3141 avatar Apr 30 '25 06:04 Courtney3141

We'll track filling out each template here https://github.com/au-ts/sddf/issues/473.

I removed the GitHub pull request template because I think it's on the PR reviewer to check for docs and I think it might turn into contributors just ticking it off without properly thinking about it.

Ivan-Velickovic avatar Aug 07 '25 02:08 Ivan-Velickovic