Repository navigation
Clarify the initial scope of the documentation #313
Description
Activity
Hi @git-staus, now I guess you understand what I meant when I said nobody is really actively contributing here. Feel free to take the lead with this and do what you feel is right.
Yeah, nothing but crickets really... However, even if it's only me, I still end up with decent-ish documentation of where I was in my thinking process.
Re just this issue: I will likely come up with a concrete answer once I get going with my stub at #311. It's still in the pipeline!
It's still in the pipeline!
Not sure why a couple of job didn't run. Now it's all done, sorry about that.
Oh sorry, I wrote in broken English and we misunderstood each other. I meant to say #311 is still in my personal metaphorical "pipeline" of things to do. "it's still on my agenda" would have been a better phrasing. Funny how it still made sense.
Reacted by Giorgio SalluzzoReacted by Giorgio SalluzzoHi @git-staus, are you still considering contributing to this?
Thank you for checking in with me. I have not made any progress on #311 but I have not forgotten about my PR and I am still willing to take charge of the documentation, even though I cannot say if I'll be able to make time tomorrow or in a few months.
Is it acceptable to leave these issues and PR open under these conditions? Perhaps you can assign me to all issues I raised.
At least I can promise to properly close all my open issues and PRs if I ever change my mind about contributing.
Reacted by Giorgio Salluzzo
A question under #308 went unanswered and I figured further discussion warranted its own issue.
Within the Diátaxis framework (what the original author went on to call this approach to documentation) I believe tutorials and thereafter technical reference work best: First you want to see what Mocket has to offer (to judge its relevance), and then adapt what you saw to your specific requirements aided by reference documentation. How-to guides also make sense for the latter step, but since Mocket seems to me to solve a relatively homogenous problem, going straight to the reference documentation might work for most. This is just my half-informed guess of course.
The articles and examples listed in the
READMEand the docstrings I found while working on #310 seem to fall in these categories of documentation already! I guess organising them into a single webpage looks better and makes them easier to find and expand upon.Other new or prospective users of Mocket are have their say here as well!