Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restructure the user guide with subsections #2302

Open
RDaxini opened this issue Nov 21, 2024 · 3 comments · May be fixed by #2310
Open

Restructure the user guide with subsections #2302

RDaxini opened this issue Nov 21, 2024 · 3 comments · May be fixed by #2310
Milestone

Comments

@RDaxini
Copy link
Contributor

RDaxini commented Nov 21, 2024

--edit-- see discussion below, the original suggestion of a new page has evolved into breaking up the user guide into subsections.

Is your feature request related to a problem? Please describe.
Some sections in the user guide don't really fit appropriately there, for example the single diode section. This section feels more educational and general, while still framed in the context of using pvlib.

Describe the solution you'd like
Create a "Learning" main header section (same level as user guide, example gallery, etc.)
Purpose of distinct sections:
Learning: educational content, including general theory, but still in the context of using pvlib / pvlib-python where explanations could be framed around particular pvlib-python functions and functionality. This section could inspire the creation of more educational content in future.
User guide: set up and installation of pvlib-python.

Transfer to the learning section:
Intro Tutorial
PVSystem
ModelChain
Time and time zones
Clear sky
Bifacial modeling
Weather data
Single Diode Equation

Keep in User Guide:
Package Overview
Installation
Variables and Symbols
Frequently Asked Questions

Additional context
In a way, these are all still 'user guide' because they guide users on how to use components of pvlib, so this idea is totally open to other suggestions and/or rejection entirely, but I am interested to hear the thoughts from the community.

@RDaxini RDaxini linked a pull request Nov 26, 2024 that will close this issue
8 tasks
@RDaxini RDaxini added this to the v0.11.2 milestone Nov 27, 2024
@kandersolar
Copy link
Member

I think I am not in favor of the proposal as currently written. Our current User Guide seems (to me) similar in scope to those of other projects (in particular, projects with good docs that we might want to emulate):

So I don't think I'm in favor of splitting off some pages into a new Learning section alongside the current User Guide.

However, I do like what NumPy and Astropy have done with organizing the User Guide into subsections. @RDaxini could we adapt your proposal to use subsections in the User Guide rather than creating a new top-level section?

@RDaxini
Copy link
Contributor Author

RDaxini commented Dec 3, 2024

I think I am not in favor of the proposal as currently written. Our current User Guide seems (to me) similar in scope to those of other projects (in particular, projects with good docs that we might want to emulate):

So I don't think I'm in favor of splitting off some pages into a new Learning section alongside the current User Guide.

However, I do like what NumPy and Astropy have done with organizing the User Guide into subsections. @RDaxini could we adapt your proposal to use subsections in the User Guide rather than creating a new top-level section?

Fair comment, good suggestion. I'll work up a draft structure for user guide subsections later and, if approved, I will just work it into the existing PR (#2310)
Anyone feel free to suggest a structure too if you like

@RDaxini
Copy link
Contributor Author

RDaxini commented Dec 5, 2024

I think a modified version of the numpy.org structure would serve us well here:

Getting started
Package Overview
Installation
Intro Tutorial
Advanced usage
ModelChain
Time and time zones
Clear sky
Bifacial modeling
Weather data
Single Diode Equation
Extras
Variables and Symbols
Frequently Asked Questions

@RDaxini RDaxini changed the title Idea: create a "learning" main header page Restructure the user guide with subsections Dec 5, 2024
@RDaxini RDaxini modified the milestones: v0.11.2, v0.11.3 Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants