Skip to content

Conversation

@konard
Copy link
Member

@konard konard commented Sep 28, 2025

Summary

This PR updates the documentation to reflect the correct terminology for Links Notation, using strikethrough formatting to show the evolution from "entities" to "references to links" throughout all documentation and code.

Changes Made

  • README.md: Updated with strikethrough formatting

    • Before: structured data as links between references to links
    • After: structured data as links between ~~entities~~ references to links
  • README.ru.md: Updated the Russian translation with strikethrough

    • Before: связей между ссылками на связи
    • After: связей между ~~сущностями~~ ссылками на связи
  • docs/index.html: Updated both meta description and hero subtitle

    • Meta description: Added ~~entities~~ strikethrough
    • Hero subtitle: Used <s>entities</s> HTML tag for strikethrough
  • docs/dist/index.html: Updated the built/dist version to match

  • csharp/Platform.Protocols.Lino/Link.cs: Updated code documentation

    • Changed: relationships between entitiesrelationships between references to links

Rationale

In the associative theory, everything is a link, but in Links Notation everything is either:

  • A link (something in parentheses), or
  • A reference to a link (symbolic or alphanumeric sequence)

This change emphasizes that we use references to links rather than abstract "entities", aligning the documentation with the core vision of Links Notation where all references are references to links. The strikethrough formatting preserves the historical context while clearly showing the terminology evolution.

Files Reviewed

✅ README.md - Updated with strikethrough
✅ README.ru.md - Updated with strikethrough
✅ docs/index.html - Updated with strikethrough (meta + hero)
✅ docs/dist/index.html - Updated built version
✅ csharp/Platform.Protocols.Lino/Link.cs - Updated code documentation
✅ FEATURE_COMPARISON.md - Reviewed (no changes needed - "entities" used in proper ORM context)
✅ All other files - Comprehensively searched and reviewed

Fixes

Fixes #99

🤖 Generated with Claude Code

Adding CLAUDE.md with task information for AI processing.
This file will be removed when the task is complete.

Issue: #99
@konard konard self-assigned this Sep 28, 2025
Changes:
- README.md: Updated description to emphasize that Links Notation represents structured data as links between references to links, not entities
- README.ru.md: Updated Russian translation to reflect the same terminology change

This change aligns with the core vision of Links Notation where everything is either a link (something in parentheses) or a reference to a link, emphasizing that we use references to links rather than abstract entities.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@konard konard changed the title [WIP] Update the website Update website and documentation terminology: 'entities' → 'references to links' Sep 28, 2025
@konard konard marked this pull request as ready for review September 28, 2025 12:00
@konard
Copy link
Member Author

konard commented Sep 28, 2025

🤖 Solution Draft Log

This log file contains the complete execution trace of the AI solution draft process.

📎 Log file uploaded as GitHub Gist (155KB)
🔗 View complete solution draft log


Log automatically attached by solve.mjs with --attach-logs option

@konard
Copy link
Member Author

konard commented Sep 28, 2025

I wanted to keep entities word but strike it through. Also are you sure you checked all the content of repository for similar cases?

@konard konard marked this pull request as draft September 28, 2025 18:20
@konard
Copy link
Member Author

konard commented Sep 28, 2025

🤖 AI Work Session Started

Starting automated work session at 2025-09-28T18:20:45.335Z

The PR has been converted to draft mode while work is in progress.

This comment marks the beginning of an AI work session. Please wait working session to finish, and provide your feedback.

Update all documentation and code to use strikethrough formatting
when replacing 'entities' with 'references to links', emphasizing
the terminology change while preserving context.

Changes:
- README.md: Added ~~entities~~ strikethrough
- README.ru.md: Added ~~сущностями~~ strikethrough
- docs/index.html: Updated meta description and hero subtitle
- docs/dist/index.html: Updated built version
- csharp/Platform.Protocols.Lino/Link.cs: Updated code documentation

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@konard konard marked this pull request as ready for review September 28, 2025 18:24
@konard
Copy link
Member Author

konard commented Sep 28, 2025

Changes completed

I've updated all documentation and code to use strikethrough formatting as requested:

Key changes:

  • All README files now show: entities references to links
  • Website (docs/index.html) uses proper strikethrough formatting
  • C# code documentation updated to match terminology
  • Comprehensive search performed to ensure no instances were missed

Files updated:

  1. README.md - strikethrough formatting
  2. README.ru.md - strikethrough formatting (сущностями)
  3. docs/index.html - meta description and hero subtitle
  4. docs/dist/index.html - built version
  5. csharp/Platform.Protocols.Lino/Link.cs - code documentation

The PR is now ready for review. All changes preserve context through strikethrough while emphasizing the correct terminology.

PR: #100

@konard
Copy link
Member Author

konard commented Sep 28, 2025

🤖 Solution Draft Log

This log file contains the complete execution trace of the AI solution draft process.

📎 Log file uploaded as GitHub Gist (185KB)
🔗 View complete solution draft log


Log automatically attached by solve.mjs with --attach-logs option

@konard
Copy link
Member Author

konard commented Sep 28, 2025

Screenshot 2025-09-28 at 11 58 52 PM

@konard konard marked this pull request as draft September 28, 2025 18:31
@konard
Copy link
Member Author

konard commented Sep 28, 2025

🤖 AI Work Session Started

Starting automated work session at 2025-09-28T18:31:39.928Z

The PR has been converted to draft mode while work is in progress.

This comment marks the beginning of an AI work session. Please wait working session to finish, and provide your feedback.

- Break long line in README.md (line 90: 87 chars → under 80)
- Break long line in README.ru.md (line 91: 92 chars → under 80)
- Maintains strikethrough formatting for terminology evolution
- Resolves +2 code style issues reported by Codacy

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@konard
Copy link
Member Author

konard commented Sep 28, 2025

Codacy line length issues fixed

I've resolved the +2 code style issues reported by Codacy:

Changes:

  • README.md line 90: Broke long line (87 chars → 2 lines under 80 chars each)
  • README.ru.md line 91: Broke long line (92 chars → 2 lines under 80 chars each)

Both files now comply with the 80-character line length limit while maintaining the strikethrough formatting for the terminology evolution (entities / сущностями).

Commit: 6d49cfd

The Codacy check should now pass. ✨

@konard konard marked this pull request as ready for review September 28, 2025 18:33
@konard
Copy link
Member Author

konard commented Sep 28, 2025

🤖 Solution Draft Log

This log file contains the complete execution trace of the AI solution draft process.

📎 Log file uploaded as GitHub Gist (224KB)
🔗 View complete solution draft log


Log automatically attached by solve.mjs with --attach-logs option

@konard konard merged commit 6aaac1d into main Sep 29, 2025
1 check passed
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.

Update the website

2 participants