adafruit / adafruit/Adafruit_CircuitPython_BLE_File_Transfer

Examples in Docs links broken

Offen
#27 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
Python
Sterne
28
Forks
5
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

visiting the RTD docs link:
https://docs.circuitpython.org/projects/ble_file_transfer/en/latest/index.html

The linked examples end up with 404 not found. I've not explored every link on every page, but it seemed consistently broken for all example links.
I am unaware if the docs should include the code examples or if the links should instead point to python file example links on github instead.

![image](https://github.com/adafruit/Adafruit_CircuitPython_BLE_File_Transfer/assets/6692083/d7f5eac2-94c1-4519-b394-4c3ed97f5b3f)

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Rechercherichtung

Öffne die RTD-Dokumentations-URL im Issue und prüfe die Beispiel-Links, die 404 zurückgeben. Bestimme, ob jeder Link innerhalb der Dokumentation aufgelöst werden sollte oder auf Python-Beispieldateien auf GitHub verweisen sollte; abgeschlossen ist die Aufgabe, wenn die Beispiel-Links konsistent funktionieren.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Bug
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

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