Skip to content

Docs/style: Reformatting the Docs#485

Open
MithraGhlm wants to merge 45 commits into
mainfrom
docs/reformat
Open

Docs/style: Reformatting the Docs#485
MithraGhlm wants to merge 45 commits into
mainfrom
docs/reformat

Conversation

@MithraGhlm
Copy link
Copy Markdown
Contributor

Description

The existing documentation, while well written, does not follow a consistent formatting style. To improve the overall coherence and presentation of the documentation, we agreed to introduce a set of basic formatting guidelines after discussions with @eeberhard and @SprGrf.

This PR starts the reformatting effort and applies the new conventions across several documentation files.

Review guidelines

Estimated Time of Review: 5 minutes

Checklist before merging:

  • Confirm that the relevant changelog(s) are up-to-date in case of any user-facing changes

MithraGhlm and others added 30 commits April 9, 2026 18:42
Co-authored-by: Spyros Garyfallidis <spyros@aica.tech>
Co-authored-by: Spyros Garyfallidis <spyros@aica.tech>
Co-authored-by: Spyros Garyfallidis <spyros@aica.tech>
Co-authored-by: Dominic Reber <71256590+domire8@users.noreply.github.com>
Co-authored-by: Dominic Reber <71256590+domire8@users.noreply.github.com>
Co-authored-by: Dominic Reber <71256590+domire8@users.noreply.github.com>
Co-authored-by: Dominic Reber <71256590+domire8@users.noreply.github.com>
Co-authored-by: Dominic Reber <71256590+domire8@users.noreply.github.com>
Co-authored-by: Dominic Reber <71256590+domire8@users.noreply.github.com>
Co-authored-by: Dominic Reber <71256590+domire8@users.noreply.github.com>
Co-authored-by: Dominic Reber <71256590+domire8@users.noreply.github.com>
…nent

Co-authored-by: Dominic Reber <71256590+domire8@users.noreply.github.com>
@MithraGhlm MithraGhlm requested review from SprGrf and yrh012 as code owners May 11, 2026 13:46
@MithraGhlm MithraGhlm requested a review from domire8 May 11, 2026 13:46
@domire8
Copy link
Copy Markdown
Member

domire8 commented May 11, 2026

This PR contains all commits from #482, could you untangle this?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants