Skip to content

Improve sphinx documentation structure #298

Open
@shakedregev

Description

@shakedregev

Summary

Currently guidelines appear under wrong titles. For example, there are developer guidelines under "Building ReSolve", which is something users need to do, regardless of if they are developers. "Building ReSolve" itself should be part of the user guidelines.

Rationale

Documentation should be addressed first to users, then to developers. Within these groups, it should start with things that are relevant to everyone and gradually become more granular about things that are relevant to a smaller set of users or developers.

Description

We should structure documentation such that information relevant to larger groups is more readily available.
We should explicitly state any implicit understandings we have between developers that conflict with official guidelines.

Additional information

No response

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions