Skip to content

Implementing new and improved documentation structure #701

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.

Sign up for GitHub

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

Jump to bottom
Draft
wants to merge 29 commits into
base: main
Choose a base branch
from
Draft

Implementing new and improved documentation structure #701

wants to merge 29 commits into from

Conversation

@egarciamendez
Copy link
Member

@egarciamendez egarciamendez commented Jul 31, 2025 •
edited
Loading

Description

Implementing new and improved documentation structure.

Try it out by:

uv run mkdocs build

afbeelding

Fixes #700

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist:

  • I have added tests that prove my fix is effective or that my feature works
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • New and existing unit tests pass locally with my changes

@egarciamendez egarciamendez linked an issue Jul 31, 2025 that may be closed by this pull request
[📚 Documentation Issue]: implement new documentation structure #700
Open
4 tasks
@github-actions
Copy link

github-actions bot commented Jul 31, 2025

Thank you so much for contributing to Blueprints!
Your contributions help thousands of engineers work more efficiently and accurately.

Now that you've created your pull request, please don't go away; take a look at the bottom of this page for the automated checks that should already be running. If they pass, great! If not, please click on 'Details' and see if you can fix the problem they've identified. A maintainer should be along shortly to review your pull request and help get it added!

@egarciamendez egarciamendez requested a review from bro-wi July 31, 2025 20:45
@egarciamendez
Copy link
Member Author

egarciamendez commented Jul 31, 2025

@bro-wi There is a lot of work in progress in here. Let's make it a documentation site worth visiting.

@egarciamendez
Merge branch 'main' into 700-documentation-issue-implement-new-docume…
55c9f08 
…ntation-structure

# Conflicts:
#	docs/.nav.yml
#	docs/guides/examples/_images/lnp_profiles.png
#	docs/guides/examples/steel_profile_shapes/steel_lnp_profile.ipynb
@egarciamendez
improve docs building speed
0530db1
@egarciamendez
Copy link
Member Author

egarciamendez commented Sep 3, 2025

The last published release should be the default when visiting the documentation page

egarciamendez and others added 19 commits September 3, 2025 09:56
@egarciamendez
improve docs building speed
c991158
@egarciamendez
update documentation structure and add scripts for generating referen…
b2b96d5 
…ce pages
@egarciamendez
small fix in nav
b8a42e9
@bro-wi
please add changelog chapter
8557c43
@bro-wi
Merge remote-tracking branch 'origin/700-documentation-issue-implemen…
112aa14 
…t-new-documentation-structure' into 730-documentation-issue-add-changelog
@bro-wi
add dirty build mode for docs with omiting generating the api referen…
4180df4 
…ce for faster builds.
@bro-wi
add changelog docs about docs and versioning system
5ff17f1
@bro-wi
renamed structure.md to library_organization.md
b68c02b
@bro-wi
added concepts index
1e0591a
@egarciamendez
Merge pull request #732 from Blueprints-org/728-documentation-issue-a…
a2b6ff1 
…dd-concepts-index
@egarciamendez
Merge pull request #731 from Blueprints-org/730-documentation-issue-a…
e69a4f5 
…dd-changelog
@egarciamendez
Merge branch 'main' into 700-documentation-issue-implement-new-docume…
ff8eda1 
…ntation-structure
@bro-wi
Merge branch 'main' into 700-documentation-issue-implement-new-docume…
d913f35 
…ntation-structure
@bro-wi
Merge branch 'main' into 700-documentation-issue-implement-new-docume…
fdd73bb 
…ntation-structure
@bro-wi
add formulas concept guide (#770)
78b695c 
* add formulas concept guide

* remove unused variable

* ruff
@egarciamendez
refactor: restructure and enhance documentation for Formula object
ef023c8
@egarciamendez
docs: update links in index.md for Eurocode and CUR-Aanbevelingen sta…
d692995 
…ndards
@egarciamendez
docs: improve documentation clarity in formula_5_11n.py and formula_7…
d35bd08 
…_18.py
@egarciamendez
fix docs
3e3a6e5
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bro-wi bro-wi Awaiting requested review from bro-wi

Copilot code review Copilot Awaiting requested review from Copilot Copilot will automatically review once the pull request is marked ready for review

At least 1 approving review is required to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[📚 Documentation Issue]: implement new documentation structure

3 participants

@egarciamendez @bro-wi