Streamline and align the "Getting Started" docs to fit in the new structure

Aperta
  • Qualcosa non va?
#1,415 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 3 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
csharp, unity
Ambito
documentation

Direzione di ricerca

Inizia dalla guida collegata Frontend Handbook, quindi fai un inventario della documentazione Getting Started della piattaforma sentry-unity e confrontala con la nuova struttura. Il lavoro è completato quando le guide pertinenti usano le sezioni Install, Configure, Verify, Next Steps opzionale e Notes, si concentrano sull’onboarding di base, aggiornano il testo e gli snippet obsoleti e collegano la configurazione avanzata a sentry-docs.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Docs Unity
Problem Statement
  • The "Getting Started" documentation for sentry-unity platforms may not conform to the newly defined format, which includes the steps "Install", "Configure", "Verify", and the optional "Next Steps".
    • The "Verify" step is not always available and it is a very important step that helps the user to verify that the installation and configuration were done correctly.
  • New users onboarding with Sentry may find the existing documentation extensive and unclear. The "Getting Started" guide should cover the basics, while more advanced configurations shall live on the sentry-docs website.
  • Some copies and code snippets in the documentation may be outdated.
Solution Brainstorm

The task goals are as follows:

  • Thoroughly review all sentry-unity platform documentation, including less commonly used sections, and reorganize their content into structured headings: 'Install,' 'Configure,' 'Verify,' and the optional 'Next Steps.'
  • The onboarding documentation should strictly focus on the basics to help users get started. Advanced configurations should be available in the complete documentation on the sentry-docs website.
  • Essential information for new users should be included under the new 'Notes' section in the onboarding documentation.
  • Update code snippets and copies as necessary.
  • If a "Verify" step is missing, include it in the documentation.

Please refer to the "Frontendend Handbook" guide in our "Sentry" main repository for assistance in adding and updating the getting started docs: Frontendend Handbook.

Project: https://github.com/getsentry/team-sdks/issues/23

Lingua principale
C#
Stelle
295
Fork
63
Merge medio
3g 17h
PR unite (30g)
26

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di getsentry/sentry-unity

Tutte le issue di getsentry/sentry-unity

Issue simili

Altre issue su C#

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.