issues
search
qri-io
/
2017-frontend
qri electron & web frontend
https://qri.io
MIT License
23
stars
7
forks
source link
docs(*): add descriptive comments to each component
#454
Open
ramfox
opened
5 years ago
ramfox
commented
5 years ago
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
[x] 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
[x] App
[ ] Online
[x] AppDrag
[ ] PageTitle
[ ] AppLoading
[ ] QuitApp.electron
[ ] AppUnavail
[ ] QuitApp.web
[x] Base
[ ] ReadOnly
[ ] ChoosePeername
[ ] SearchResults
[ ] CodeViewer
[ ] StatsBar
[ ] Collection
[ ] StatsLine
[ ] DatasetName
[ ] StatsSection
[ ] Datasets
[ ] TabPanel
[ ] Datestamp
[ ] TagList
[ ] ExternalLink.electron
[ ] Welcome
[ ] ExternalLink.web
Let's cut down on mental overhead by commenting each component with:
Chrome
dataset
editor
form
item
profile
schema
stylesheet
general