Skip to content

Some more documentation progress#345

Merged
Jutho merged 16 commits intomainfrom
jh/continuedocs
Feb 13, 2026
Merged

Some more documentation progress#345
Jutho merged 16 commits intomainfrom
jh/continuedocs

Conversation

@Jutho
Copy link
Member

@Jutho Jutho commented Jan 6, 2026

This includes a major restructuring (breaking down long pages into separate pages) and a complete rewrite of the Sector documentation. This could become the manual page for TensorKitSectors.jl in time, but for now I would still include it here.

By lack of a good Markdown formatter, I switched to breaking lines at natural places (end of sentence, subsentences, …), like one might do with LaTeX documents. Maybe that strategy can lead to clean git diffs in future (potentially smaller) doc changes, but I am open to other suggestions.

This would very much benefit from some proofreading by e.g. @borisdevos , @leburgel , @lkdvos .

@codecov
Copy link

codecov bot commented Jan 6, 2026

Codecov Report

❌ Patch coverage is 50.00000% with 2 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
src/tensors/linalg.jl 0.00% 2 Missing ⚠️
Files with missing lines Coverage Δ
src/tensors/braidingtensor.jl 68.29% <ø> (ø)
src/tensors/indexmanipulations.jl 73.42% <100.00%> (+0.09%) ⬆️
src/tensors/linalg.jl 82.59% <0.00%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@github-actions
Copy link
Contributor

github-actions bot commented Jan 6, 2026

After the build completes, the updated documentation will be available here

Co-authored-by: Boris De Vos <143942306+borisdevos@users.noreply.github.com>
@lkdvos lkdvos force-pushed the jh/continuedocs branch 3 times, most recently from 0e08554 to a0ee325 Compare February 11, 2026 19:04
@lkdvos
Copy link
Member

lkdvos commented Feb 11, 2026

I think I managed to resolve most of Boris' comments now, I wonder if it makes sense to simply go ahead and merge this in its current state. At least some of the sections that still refer to old factorization functions are now cleaned up, so we should put a little haste on this.

@lkdvos lkdvos linked an issue Feb 11, 2026 that may be closed by this pull request
lkdvos
lkdvos previously approved these changes Feb 12, 2026
Copy link
Member

@lkdvos lkdvos left a comment

Choose a reason for hiding this comment

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

@Jutho I think it would be nice to simply merge this, let me know what you think.

@Jutho
Copy link
Member Author

Jutho commented Feb 12, 2026

On the one hand, I think I don't have local changes so I am not opposed to merging this. However, my Markdown formatter screwed up some of the markdown like the note blocks, and there might be other issues still as well:

Screenshot 2026-02-12 at 14 30 30 Screenshot 2026-02-12 at 14 30 43

So I think a bit more review and corrections are still necessary. I'll try to make some time tonight.

@borisdevos
Copy link
Member

I had the same with note blocks, but that's because I replaced every "." with a "(shift+enter).", so that ruins note blocks which need to be tabbed. I also saw this issue for lists.

lkdvos
lkdvos previously approved these changes Feb 12, 2026
Copy link
Member

@lkdvos lkdvos left a comment

Choose a reason for hiding this comment

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

You should probably quickly check everything is now done correctly, but I did read through the entire docs again, changed the markdown into one sentence per line, and fixed a few typos etc.
For me this is now definitely good to go.

Co-authored-by: Boris De Vos <143942306+borisdevos@users.noreply.github.com>
@Jutho Jutho merged commit 227b5f3 into main Feb 13, 2026
41 of 42 checks passed
@Jutho Jutho deleted the jh/continuedocs branch February 13, 2026 15:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation inconsistent with actual operations that exist

3 participants

Comments