docs: developer gaps from the 0.7.0 review

Ouverte
#512 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
52/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
javascript
Domaine
documentation

Piste de recherche

Start with docs/reference/rest.md and engine.md, then locate the exports from pivotkit-core/import, pivotkit-element, and pivotkit-react to confirm their names and chart constants. Update the examples and descriptions for authentication, 403 errors, invalid filters, and the differing view type names. Done when each listed gap is documented accurately; the issue does not name tests to run.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

documentation

Developer-facing gaps from the full review before 0.7.0:

  • docs/reference/rest.md embed example needs PIVOTKIT_TOKEN or auth.tokens and leaves rows undefined.
  • 403 NOT_ALLOWED text says "your token may not download files" when the server has no sign-in.
  • Undocumented exports: cleanText (pivotkit-core/import) and the chart constants BOTTOM_LEGEND_ROOM, CATEGORY_LABEL_WIDTH, GROUP_LABEL_ROOM, RIGHT_LEGEND_MIN_WIDTH, SLANTED_LABEL_WIDTH.
  • computePivot drops an invalid filter and returns the unfiltered pivot; engine.md should tell hosts to check issues for errors (or a strict option).
  • pivotkit-element exports PivotView, pivotkit-react uses ViewInput for the same thing.
Langage dominant
JavaScript
Étoiles
1
Forks
1
Merge moyen
3 h 34 min
PR mergées (30 j)
213

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de eizedev/pivotkit

Toutes les issues de eizedev/pivotkit

Issues similaires

Plus d'issues JavaScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.