Skip to content

Conversation

@austin-schaefer
Copy link
Contributor

I did a full edit of the Overview, Install, and all the Getting Started docs. For the other docs, I did a quick edit to improve capitalization consistency and add SEO descriptions but otherwise left the docs as-is.

Key changes:

  • Removing capitalized terms
  • Deleting repetitive text; in many instances, the LLM-written docs described the same feature multiple times or in mulitple places. I also removed many "summary"-type sections, which are less necessary if the docs are shorter.
  • Remove sales-y language, especially where we're describing basic features like searching or saving.
  • Simplifying structure with tables, bullet points, more consistent use of headers.
  • Removing tips, notes, etc and integrating them into text.

I didn't have time to line-edit the docs in Core Concepts, Component Development, and References. But if you want to continue the edit, here is what you should look for:

  • In many cases (pipelines persistence, overview, core concepts, first pipelines) I deleted large amounts of text. This is because LLMs tend to over-document: Too much detail, and lots of repetition.
  • Watch for excess selling. LLMs often over-sell basic features. For example, I removed largea mounts of text explaining why undo/redo is valuable.
  • Many docs also over-use tips, notes, and similar components. That makes the docs harder to scan because there are lots of visual elements competing for attention.

camielvs
camielvs previously approved these changes Dec 1, 2025
Copy link
Contributor

@camielvs camielvs left a comment

Choose a reason for hiding this comment

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

Changes seem reasonable to me. Probably needs a passover from @maxy-shpfy as the original author of the content

Copy link
Contributor

@camielvs camielvs left a comment

Choose a reason for hiding this comment

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

Switching review so Max can give explicit approval once he's reviewed.

@camielvs camielvs self-requested a review December 1, 2025 21:12
@camielvs camielvs dismissed their stale review December 1, 2025 21:12

It looks fine to me but want explicit review & approval from original authors before merging

Co-authored-by: Camiel vs <93798047+camielvs@users.noreply.github.com>
@camielvs camielvs merged commit dbea7de into TangleML:master Dec 5, 2025
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