docs(README): remove duplicated sections and restore clean profession…

[Maverick0351a]

User description

…al layout; keep Redis optional notes

Summary

Type of Change

• Bug fix
• New feature
• Documentation update
• Performance improvement
• Refactor / internal
• Other (describe)

Checklist

• Tests added/updated (or not needed)
• Docs updated (README / docs/)
• CHANGELOG updated (or not needed)
• Lint (ruff) passes locally
• Type checks (mypy) pass locally
• No performance regression (bench / perf_check as appropriate)

Details

Screenshots / Logs (if applicable)

Related Issues

---

PR Type

Documentation

---

Description

• Remove duplicated sections and redundant content

• Restore clean professional layout structure

• Simplify table of contents to essential sections

• Keep Redis optional notes and API examples

---

Diagram Walkthrough

flowchart LR
  A["Original README"] --> B["Remove Duplicates"]
  B --> C["Simplify TOC"]
  C --> D["Clean Layout"]
  D --> E["Professional README"]

Loading

File Walkthrough

	Relevant files
Documentation	README.md Major README cleanup and deduplication                                      README.md Removed extensive duplicated sections including multiple quickstart examples Simplified table of contents from detailed breakdown to essential sections Cleaned up redundant SDK examples and installation instructions Maintained core API examples and Redis-related documentation +15/-178

---

[qodo-code-review]

PR Compliance Guide 🔍

Below is a summary of compliance checks for this PR:

Security Compliance
⚪	Insecure env var usage Description: Example code accesses environment variable OSCILLINK_API_KEY without a default or error handling in documentation, which can lead to accidental exposure or runtime crashes if copied verbatim; advise safer patterns like using get with checks or placeholders. README.md [294-300] Referred Code API_BASE = os.environ.get("OSCILLINK_API_BASE", "https://api2.odinprotocol.dev") API_KEY = os.environ["OSCILLINK_API_KEY"] r = httpx.post( f"{API_BASE}/v1/settle", json={"Y": [[0.1,0.2]], "psi": [0.1,0.2], "options": {"bundle_k": 1, "include_receipt": True}}, headers={"X-API-Key": API_KEY}, )
Ticket Compliance
⚪	🎫 No ticket provided Create ticket/issue
Codebase Duplication Compliance
⚪	Codebase context is not defined Follow the guide to enable codebase context checks.
Custom Compliance
⚪	No custom compliance provided Follow the guide to enable custom compliance check.
Update

Compliance status legend

🟢 - Fully Compliant
🟡 - Partial Compliant
🔴 - Not Compliant
⚪ - Requires Further Human Verification
🏷️ - Compliance label

[qodo-code-review]

PR Code Suggestions ✨

Explore these optional code suggestions:

Category	Suggestion	Impact
High-level	Restore key introductory user onboarding sections The README refactoring removed important onboarding sections like a "TL;DR" and a quickstart example from the top. It is suggested to reintroduce concise versions of these elements to improve the experience for new users. Examples: README.md [53-73] --- ## Contents - Overview - Quickstart - Adapters & Compatibility - Reproducibility - Performance - Method (Technical) ... (clipped 11 lines) Solution Walkthrough: Before: ... --- ## Contents - Overview - Quickstart - ... --- pip install oscillink # Oscillink — Self‑Optimizing Coherent Memory for Embedding Workflows Build coherence into retrieval and generation. Deterministic receipts for every decision. ... After: ... --- ## TL;DR - Coherent memory for any model (LLMs, image, video, etc.) — no retraining. - Deterministic receipts for auditability and reproducibility. - ... ## Quickstart (60 seconds) ```bash pip install oscillink python -c "import numpy as np; from oscillink import Oscillink; ..." Contents Overview ... ... <details><summary>Suggestion importance[1-10]: 8</summary> __ Why: The suggestion correctly identifies that removing key onboarding sections like `TL;DR` and a top-level quickstart example harms the new user experience, which is a critical aspect of a project's main README file. </details></details></td><td align=center>Medium </td></tr><tr><td rowspan=1>Possible issue</td> <td> <details><summary>Prevent crash if API key missing</summary> ___ **Modify the API key retrieval in the example to use <code>os.environ.get()</code> with a <br>default placeholder, preventing a <code>KeyError</code> if the environment variable is not <br>set.** [README.md [295]](https://github.com/Maverick0351a/Oscillink/pull/17/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R295-R295) ```diff -API_KEY = os.environ["OSCILLINK_API_KEY"] +API_KEY = os.environ.get("OSCILLINK_API_KEY", "YOUR_API_KEY_HERE") # Replace with your API key Apply / Chat Suggestion importance[1-10]: 7 __ Why: The suggestion correctly identifies a potential KeyError in the example code and proposes a more robust way to handle the missing environment variable, improving user experience.	Medium
General	Make table of contents navigable Convert the plain list items in the "Contents" section into clickable markdown links to improve document navigation. README.md [57-67] -- Overview -- Quickstart -- Adapters & Compatibility -- Reproducibility -- Performance -- Method (Technical) -- Deployment Options -- Security, Privacy, Legal -- Troubleshooting -- Contributing & License -- Changelog +- [Overview](#overview) +- [Quickstart](#quickstart) +- [Adapters & Compatibility](#adapters--compatibility) +- [Reproducibility](#reproducibility) +- [Performance](#performance) +- [Method (Technical)](#method-technical) +- [Deployment Options](#deployment-options) +- [Security, Privacy, Legal](#security-privacy-legal) +- [Troubleshooting](#troubleshooting) +- [Contributing & License](#contributing--license) +- [Changelog](#changelog) Apply / Chat Suggestion importance[1-10]: 6 __ Why: The suggestion correctly identifies that the new table of contents lacks navigation links and proposes adding them, which significantly improves the document's usability.	Low
Update