Skip to content

Improving documentation - #30

Merged
Lucccyo merged 8 commits into
mainfrom
improving_documentation
May 28, 2026
Merged

Lucccyo merged 8 commits into
mainfrom
improving_documentation

Conversation

@Lucccyo

@Lucccyo Lucccyo commented May 21, 2026

Copy link
Copy Markdown
Contributor

No description provided.

@Lucccyo
Lucccyo requested a review from xvw May 21, 2026 14:01

@xvw xvw left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Very good!
I think that it is ... a little bit too much, and it will involve (from my POV) high maintenance. So i suggest to reduce/drop some section. But since it is a personal point of view, feel free to discard my comments :)

(cc @pitag-ha and @voodoos, any opinion?)

Comment thread ARCHITECTURE.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread ARCHITECTURE.md Outdated
Comment thread ARCHITECTURE.md
Comment thread CONTRIBUTING.md Outdated

@voodoos voodoos left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I agres that Architecture.md should only contain high level information. Lower level details should go to the sources directly, where it will be more natural to keep them in sync when performing changes.

@Lucccyo
Lucccyo force-pushed the improving_documentation branch from 4088610 to f0a20dd Compare May 28, 2026 12:12
@Lucccyo
Lucccyo requested a review from xvw May 28, 2026 12:13
@Lucccyo
Lucccyo merged commit f1ef89e into main May 28, 2026
1 check passed
@xvw
xvw deleted the improving_documentation branch May 28, 2026 12:37
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.

3 participants