Skip to content

Documentation revamp user guide (optimisation, components)#1292

Merged
fneum merged 16 commits intov1-docsfrom
fneum/v1-docs
Jul 24, 2025
Merged

Documentation revamp user guide (optimisation, components)#1292
fneum merged 16 commits intov1-docsfrom
fneum/v1-docs

Conversation

@fneum
Copy link
Copy Markdown
Member

@fneum fneum commented Jul 23, 2025

No description provided.

@fneum fneum added the docs Documentation improvements or features to be showcased in docs/ notebook label Jul 23, 2025
@fneum fneum added this to the v1.0 milestone Jul 23, 2025
@fneum fneum self-assigned this Jul 23, 2025
Copy link
Copy Markdown
Member

@lkstrp lkstrp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Beaaaauuutiful 💃

Feel free to merge whenever you're ready, and I'll follow up in v1-docs

@fneum fneum marked this pull request as ready for review July 24, 2025 09:21
@fneum fneum merged commit fe5ae8c into v1-docs Jul 24, 2025
3 of 19 checks passed
@fneum fneum deleted the fneum/v1-docs branch July 24, 2025 09:21
lkstrp pushed a commit that referenced this pull request Jul 25, 2025
* documentation user guide revamp (optimisation, components)

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* add undocumented component attributes

* revised list of features

* add that transmission loss approximation needs to be activated

* some fun: more emojis :)

* add learning resources (to be extended)

* revise FAQs answers

* move code of conduct

* remove API overview (reduce pages)

* user guide overview (short and sweet)

* suggestion for contributors page

* small adjustments to features list

* three quickstart examples on diff topics

* quickstart examples

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
lkstrp pushed a commit that referenced this pull request Aug 4, 2025
* documentation user guide revamp (optimisation, components)

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* add undocumented component attributes

* revised list of features

* add that transmission loss approximation needs to be activated

* some fun: more emojis :)

* add learning resources (to be extended)

* revise FAQs answers

* move code of conduct

* remove API overview (reduce pages)

* user guide overview (short and sweet)

* suggestion for contributors page

* small adjustments to features list

* three quickstart examples on diff topics

* quickstart examples

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation improvements or features to be showcased in docs/ notebook

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants