Skip to content
This repository has been archived by the owner on Sep 10, 2021. It is now read-only.

docs(*): add descriptive comments to each component #454

Open
ramfox opened this issue Feb 13, 2019 · 0 comments
Open

docs(*): add descriptive comments to each component #454

ramfox opened this issue Feb 13, 2019 · 0 comments
Labels
backlog
Milestone
0.7.1

Comments

@ramfox
Copy link
Member

ramfox commented Feb 13, 2019 •
edited
Loading

Let's cut down on mental overhead by commenting each component with:

  • it's main function
  • describing some primary/important states
  • describing some primary/important logic

Chrome

  • chrome/Button
  • chrome/DropdownMenu
  • chrome/NavLinks
  • chrome/TopBar
  • chrome/Dropdown
  • chrome/LoadMore
  • chrome/Spinner

dataset

  • dataset/Body
  • dataset/DeleteDataset
  • dataset/Render
  • dataset/BodyReadOnly
  • dataset/Export
  • dataset/Structure
  • dataset/Commits
  • dataset/Meta
  • dataset/StructureViewer
  • dataset/Dataset
  • dataset/MetaSummary
  • dataset/Transform
  • dataset/DatasetButtonGroup
  • dataset/MetadataViewer
  • dataset/Viz
  • dataset/DatasetHeader
  • dataset/Overview
  • dataset/DatasetRouter
  • dataset/RenameDataset

editor

  • editor/EditBody
  • editor/EditTransform
  • editor/Overview
  • editor/EditMeta
  • editor/EditViz
  • editor/Results
  • editor/EditStructure
  • editor/Editor
  • editor/SectionPicker

form

  • form/DateInput
  • form/TextInput
  • form/DropFile
  • form/UrlInput
  • form/KeyValueInput
  • form/ValidCheck
  • form/LanguageInput
  • form/ValidCitationsInput
  • form/MetadataForm
  • form/ValidContributorsInput
  • form/MonthCalendar
  • form/ValidDateTimeInput
  • form/ProfileForm
  • form/ValidInput
  • form/RadioInput
  • form/ValidLicenseInput
  • form/SaveMetadataForm
  • form/ValidPeriodicityInput
  • form/SearchBar
  • form/ValidSelect
  • form/StructureForm
  • form/ValidTextarea
  • form/StructureFormatConfig
  • form/ViewModeButton
  • form/TagInput

item

  • item/CitationItem
  • item/FieldItem
  • item/StatItem
  • item/CommitItem
  • item/KeyValueItem
  • item/TagItem
  • item/ContributorItem
  • item/ProfileItem
  • item/DatasetItem
  • item/SearchItem

profile

  • profile/NoProfile
  • profile/ProfileBar
  • profile/ProfileHeader
  • profile/Profile
  • profile/ProfileEditor
  • profile/ProfilePhoto

schema

  • schema/EditSchema
  • schema/schema

stylesheet

  • stylesheet/Stylesheet
  • stylesheet/Swatch

general

  • App
  • Online
  • AppDrag
  • PageTitle
  • AppLoading
  • QuitApp.electron
  • AppUnavail
  • QuitApp.web
  • Base
  • ReadOnly
  • ChoosePeername
  • SearchResults
  • CodeViewer
  • StatsBar
  • Collection
  • StatsLine
  • DatasetName
  • StatsSection
  • Datasets
  • TabPanel
  • Datestamp
  • TagList
  • ExternalLink.electron
  • Welcome
  • ExternalLink.web
@ramfox ramfox added this to the 0.7.1 milestone Feb 13, 2019
@b5 b5 added the backlog label Feb 18, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
backlog
Projects
None yet
Milestone
0.7.1
Development

No branches or pull requests
2 participants
@b5 @ramfox