Skip to content

FCE-1596: Docs restructure #133

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
Merged
merged 46 commits into from
Jul 23, 2025
Merged

FCE-1596: Docs restructure #133

merged 46 commits into from
Jul 23, 2025

Conversation

@MiloszFilimowski
Copy link
Contributor

@MiloszFilimowski MiloszFilimowski commented Jun 30, 2025 •
edited
Loading

Description

There is a lot to read here so I guess this PR will take a long time to review...
I welcome any of your suggestions and changes. We can treat it as a draft to work on.

What's new?

  • Docs are restructured based on this guide: https://diataxis.fr/
  • Much of the existing content just orgnized into a diffrent place
  • There is also a lot of new LLM generated content. I tried to review the changes, especially the tutorials and examples if they work and they do as of 02.07.2025. There are also some new LLM generated pages in Concepts sections. I tried to make them more verbose and more pleasing to read and I think this was achived but there might be some LLM bullshit I might've missed.
  • Replaced markdown-spellcheck with https://cspell.org/ because it has support for MDX. I just couldn't get the old lib to work with mdx comments, and cspell works great.

@MiloszFilimowski MiloszFilimowski changed the title restructure docs FCE-1596: Docs restructure Jul 2, 2025
@linear
Copy link

linear bot commented Jul 2, 2025

FCE-1596 Plan the docs restructure

@MiloszFilimowski MiloszFilimowski marked this pull request as ready for review July 2, 2025 19:09
AHGIJMKLKKZNPJKQR
AHGIJMKLKKZNPJKQR reviewed Jul 21, 2025
View reviewed changes
@AHGIJMKLKKZNPJKQR AHGIJMKLKKZNPJKQR self-assigned this Jul 22, 2025
PiotrWodecki
PiotrWodecki reviewed Jul 22, 2025
View reviewed changes
AHGIJMKLKKZNPJKQR and others added 3 commits July 22, 2025 15:55
@AHGIJMKLKKZNPJKQR @PiotrWodecki
Apply suggestions from code review
9a40004 
Co-authored-by: Piotr Wodecki <44680063+PiotrWodecki@users.noreply.github.com>
@AHGIJMKLKKZNPJKQR
Sort tutorials
8747d25
@AHGIJMKLKKZNPJKQR
Cleanup cuts
f5aac49
PiotrWodecki
PiotrWodecki reviewed Jul 22, 2025
View reviewed changes
Copy link
Member

@PiotrWodecki PiotrWodecki left a comment

Choose a reason for hiding this comment

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

part 2 out of 3

roznawsk
roznawsk requested changes Jul 23, 2025
View reviewed changes
PiotrWodecki
PiotrWodecki reviewed Jul 23, 2025
View reviewed changes
czerwiukk
czerwiukk reviewed Jul 23, 2025
View reviewed changes
@AHGIJMKLKKZNPJKQR AHGIJMKLKKZNPJKQR merged commit 40e3313 into main Jul 23, 2025
1 check passed
@AHGIJMKLKKZNPJKQR AHGIJMKLKKZNPJKQR deleted the restructure branch July 23, 2025 14:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@AHGIJMKLKKZNPJKQR AHGIJMKLKKZNPJKQR AHGIJMKLKKZNPJKQR left review comments

@roznawsk roznawsk roznawsk approved these changes

@Karolk99 Karolk99 Awaiting requested review from Karolk99

@PiotrWodecki PiotrWodecki Awaiting requested review from PiotrWodecki

@czerwiukk czerwiukk Awaiting requested review from czerwiukk

Assignees

@AHGIJMKLKKZNPJKQR AHGIJMKLKKZNPJKQR

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@MiloszFilimowski @czerwiukk @PiotrWodecki @AHGIJMKLKKZNPJKQR @roznawsk