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

Suggestion: reorganise user guide folder with subfolders #2368

Open
RDaxini opened this issue Jan 29, 2025 · 5 comments
Open

Suggestion: reorganise user guide folder with subfolders #2368

RDaxini opened this issue Jan 29, 2025 · 5 comments

Comments

@RDaxini
Copy link
Contributor

RDaxini commented Jan 29, 2025

Is your feature request related to a problem? Please describe.
The user guide folder is becoming pretty packed with a range of different files. More files are soon to be added, e.g. through #2353.

Describe the solution you'd like
Would it be helpful to organise the files using subfolders? These could align with the structure of the new readthedocs subsections (#2310), as one possibility.
I think subfolders would make navigating the folder easier now, and even more so once more pages are added (#2329).

Describe alternatives you've considered
No subfolders...

@cwhanse
Copy link
Member

cwhanse commented Jan 29, 2025

We're having this discussion at my lab. In my view, the current User Guide would be better separated into three subheadings:

1 Getting Started - the Introductory tutorial is the only content we have that I would put here
2 Modeling Guide - steps through the modeling process giving a bit of theory for each step, and a guide to implementation in pvlib
3 Technical Reference - material that is supplementary to the modeling guide, such as the details about the single diode equation and its solution

@RDaxini
Copy link
Contributor Author

RDaxini commented Jan 30, 2025

@cwhanse just to clarify, are you talking about subsections for the section navigation pane on the user-facing readthedocs site, or sorting the .rst files, which are inside the user guide folder, into subfolders of those names?

@cwhanse
Copy link
Member

cwhanse commented Jan 30, 2025

I was thinking about the user-facing navigation panes.

@RDaxini
Copy link
Contributor Author

RDaxini commented Jan 30, 2025

Ah okay, since I thought that matter was settled in #2310, in this issue I was thinking about the file organisation. I'm open to reworking the user-facing subsections though. Is it possible to re-open a merged PR?

@cwhanse
Copy link
Member

cwhanse commented Jan 30, 2025

Let's not go back on merged PRs. What I put up here as an idea, is a subdivision of the Advanced usage section from #2310, into Modeling Guide and Technical Reference.

Sorry I confused your proposal (sort the files) with the user-facing menus.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants