... we have a gap between the reference manual (which is extensive but has
no flow) and the thematic tutorials (which are written to tell a story but
are just introductions).
I agree.
- It is very hard to find features and learn how to use them for a subject
that I am not already
On 11 March 2024 05:39:36 GMT, John H Palmieri wrote:
>Dima's suggestion is appealing, and somewhat along those lines, I like the
>idea changing Sage to use some standard documentation style
>(https://github.com/sagemath/sage/issues/31044). If the program provides a
>technical writer,
Dima's suggestion is appealing, and somewhat along those lines, I like the
idea changing Sage to use some standard documentation style
(https://github.com/sagemath/sage/issues/31044). If the program provides a
technical writer, though, those may not be suitable goals. A quick glance
at least
I think the main question is who is willing to take the lead on writing and
submitting applications (before April 2). I don't have enough time in the
next three weeks to do any writing, but I am willing to help brainstorm
what form the proposal(s) should take and help edit proposals if someone
Yes, we could prepare several proposals for separate projects.
One can see in the lists of past funded projects that some organizations
have received funding for two simultaneous projects.
On Sunday, March 10, 2024 at 8:38:13 AM UTC-7 John Cremona wrote:
> Should there not be separate projects
Not sure whether switching Sage to standard Sphinx/Python docbuilding tools
falls within the remit of the Season of Docs, but it's surely a worthwhile
project - in particular if we can get funds for it.
On Sun, Mar 10, 2024 at 3:03 PM David Roe wrote:
> I think this would be good for Sage. I
Should there not be separate projects for documenting (1) building and
installing Sage; (2) using Sage (perhaps with some subject-specific
tutorials, some of which exist but might be worth updating) and (3)
documenting individual Sage functions and methods.
These require different expertise, for
I think this would be good for Sage. I think there are several decisions
to be made:
* What are our most pressing documentation needs? Personally, I think we
have a gap between the reference manual (which is extensive but has no
flow) and the thematic tutorials (which are written to tell a story
SageMath could benefit from hiring a technical writer for a project to
improve the Sage documentation. Google Season of Docs is a program that
supports such projects. Some key facts:
- total project budget $5,000 - $15,000 USD (via OpenCollective) -
