search

dbbs-lab / bsb-core

The Brain Scaffold Builder
https://bsb.readthedocs.io
GNU General Public License v3.0
22 stars 16 forks source link

docs: New documentation #858

Open filimarc opened 4 months ago

filimarc commented 4 months ago

Describe the work done

Update documentation to BSB versions 4.x

Tasks

[X] Updated documentation

📚 Documentation preview 📚: https://bsb--858.org.readthedocs.build/en/858/

Helveg commented 4 months ago

Oh, also please either fill out the PR description, or remove the template. You linked issues 1, 2 and 3 ;)

codecov[bot] commented 2 months ago

Codecov Report

Attention: Patch coverage is 55.88235% with 15 lines in your changes missing coverage. Please review.

Project coverage is 89.06%. Comparing base (ab77c6f) to head (047f1f5). Report is 8 commits behind head on main.

Files with missing lines Patch % Lines
bsb/cli/commands/_commands.py 40.00% 6 Missing :warning:
bsb/config/_distributions.py 50.00% 5 Missing :warning:
bsb/topology/partition.py 33.33% 2 Missing :warning:
bsb/cli/commands/_projects.py 0.00% 1 Missing :warning:
bsb/placement/indicator.py 66.66% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #858 +/- ## ========================================== - Coverage 89.09% 89.06% -0.03% ========================================== Files 110 110 Lines 15164 15231 +67 ========================================== + Hits 13510 13566 +56 - Misses 1654 1665 +11 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

filimarc commented 1 month ago

I removed the part of alternative URI scheme in getting started guide because the nm: scheme seems to no long be supported.

drodarie commented 1 week ago

We should start a new batch of review right away since there are a lot to check and we would like to merge it as soon as possible as new users will probably use the tool soon (Erice school).