harmony-development / harmony-development/protocol

limitations of spanned text formatting

Offen
#71 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Go
Sterne
20
Forks
2
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

The formatting system we have now currently has clients provide text ranges to format in specific ways. This has a few flaws compared to markdown which should be addressed:

1. Harder to upgrade. Clients will need to update their text inputs to make it possible to use new formatting capabilities. Increases maintainer workload. With markdown, unsupported syntax could still be written with an outdated client and it would still work.

2. Impossible / Inconsistent on some platforms. Bridges from other services will face issues with formatting, because of how on most of them the formatting is fundamentally text-based.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Beginne mit der Überprüfung des aktuellen Protokollschemas und seiner Darstellung der Textbereichsformatierung; das Issue nennt keine Datei, keinen Test und keinen Einstiegspunkt. Ermittle, wie eine auf Markdown basierende Darstellung den bestehenden Ansatz ersetzen oder adressieren könnte, und definiere anschließend vor der Implementierung das erforderliche Schema und das Kompatibilitätsverhalten.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
go, markdown
Bereich
api, backend-api-design
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.