Skip to content

Initial draft architecture for FAQ/Troubleshooting.#1939

Open
bobbyxng wants to merge 10 commits intomasterfrom
faq
Open

Initial draft architecture for FAQ/Troubleshooting.#1939
bobbyxng wants to merge 10 commits intomasterfrom
faq

Conversation

@bobbyxng
Copy link
Collaborator

@bobbyxng bobbyxng commented Dec 9, 2025

Changes proposed in this Pull Request

image

Checklist

  • I tested my contribution locally and it works as intended.
  • Code and workflow changes are sufficiently documented.
  • A release note doc/release_notes.rst is added.

@fneum
Copy link
Member

fneum commented Dec 10, 2025

Sure, great idea! But would keep it simple without the expansion: better Ctrl+F experience and less code.

@bobbyxng
Copy link
Collaborator Author

bobbyxng commented Jan 7, 2026

Exchange @toniseibold @bobbyxng on structure, inspired by open-energy-transition#276:

  • General
  • Solving
  • Model customisation
    (Constraints, input data, preprocessing...)
  • Results & postprocessing
  • Contribution & support

@bobbyxng bobbyxng marked this pull request as ready for review January 7, 2026 14:22
@bobbyxng
Copy link
Collaborator Author

bobbyxng commented Jan 7, 2026

@toniseibold and I added an initial set of questions, answers and also transferred some boxes from our OET colleagues (open-energy-transition#276). We added some sections for a basic structure and removed the expanding boxes following your comment to keep it simple, but I do think the admonition style boxes are quite nice, visually. @fneum: Could you have another look?

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants