Skip to content

Commit

Permalink
Switch to @docs signifier for remedocs comments
Browse files Browse the repository at this point in the history
  • Loading branch information
mirisuzanne committed Sep 18, 2019
1 parent ca088f4 commit 539392b
Show file tree
Hide file tree
Showing 4 changed files with 35 additions and 35 deletions.
26 changes: 13 additions & 13 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,14 +42,14 @@ The `process` folder contains related materials:
We're using code comments with
[Doxray](https://github.com/himedlooff/doxray)
to automatically generate our online documentation.
Comments start with `/* doxray`,
Comments start with `/* @docs`,
and use [YAML](https://learnxinyminutes.com/docs/yaml/) structure,
and [Markdown](https://commonmark.org/help/)
for notes.
It looks like this:

```css
/* doxray
/* @docs
label: Name The Remedy (required)
note: |
Expand Down Expand Up @@ -81,7 +81,7 @@ comment that describes the purpose
and contents of that file:

```css
/* doxray
/* @docs
label: Name The File (required)
version: 0.1.0-beta.1 (required)
Expand All @@ -98,13 +98,13 @@ out-of-context.
## Release Checklist
- [ ] Update inline documentation comments as needed
- [ ] Update `CHANGELOG.md` with bugfixes, new remedies, and breaking changes
- [ ] Update version using [SemVer](https://semver.org/), and record in:
- [ ] `package.json`
- [ ] `CHANGELOG.md`
- [ ] CSS file-level comments
- [ ] If possible, run RemeDocs locally to test documentation build
- [ ] Merge changes into the `master` branch
- [ ] Create a release on GitHub
- [ ] Publish release on NPM
- Update inline documentation comments as needed
- Update `CHANGELOG.md` with bugfixes, new remedies, and breaking changes
- Update version using [SemVer](https://semver.org/), and record in:
- `package.json`
- `CHANGELOG.md`
- CSS file-level comments
- If possible, run RemeDocs locally to test documentation build
- Merge changes into the `master` branch
- Create a release on GitHub
- Publish release on NPM
2 changes: 1 addition & 1 deletion css/quotes.css
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/* doxray
/* @docs
label: Quotes
version: 0.1.0-beta.1
Expand Down
32 changes: 16 additions & 16 deletions css/remedy.css
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/* doxray
/* @docs
label: Core Remedies
version: 0.1.0-beta.1
Expand All @@ -10,7 +10,7 @@ category: file
*/


/* doxray
/* @docs
label: Box Sizing
note: |
Expand All @@ -21,7 +21,7 @@ category: global
*, ::before, ::after { box-sizing: border-box; }


/* doxray
/* @docs
label: Line Sizing
note: |
Expand All @@ -36,7 +36,7 @@ category: global
html { line-sizing: normal; }


/* doxray
/* @docs
label: Body Margins
note: |
Expand All @@ -47,7 +47,7 @@ category: global
body { margin: 0; }


/* doxray
/* @docs
label: Heading Sizes
note: |
Expand All @@ -63,7 +63,7 @@ h5 { font-size: 0.83rem; }
h6 { font-size: 0.67rem; }


/* doxray
/* @docs
label: H1 Margins
note: |
Expand All @@ -74,7 +74,7 @@ category: typography
h1 { margin: 0.67em 0; }


/* doxray
/* @docs
label: Pre Wrapping
note: |
Expand All @@ -85,15 +85,15 @@ category: typography
pre { white-space: pre-wrap; }


/* doxray
/* @docs
label: Horizontal Rule
note: |
1. Solid, thin horizontal rules
2. Remove Firefox `color: gray`
3. Remove default `1px` height, and common `overflow: hidden`
category: typography
category: typography
*/
hr {
border-style: solid;
Expand All @@ -104,7 +104,7 @@ hr {
}


/* doxray
/* @docs
label: Responsive Embeds
note: |
Expand All @@ -121,7 +121,7 @@ img, svg, video, canvas, audio, iframe, embed, object {
}


/* doxray
/* @docs
label: Aspect Ratios
note: |
Expand All @@ -137,7 +137,7 @@ img, svg, video, canvas {
}


/* doxray
/* @docs
label: Audio Width
note: |
Expand All @@ -149,7 +149,7 @@ category: embedded elements
audio { width: 100%; }


/* doxray
/* @docs
label: Image Borders
note: |
Expand All @@ -160,7 +160,7 @@ category: legacy browsers
img { border-style: none; }


/* doxray
/* @docs
label: SVG Overflow
note: |
Expand All @@ -171,7 +171,7 @@ category: legacy browsers
svg { overflow: hidden; }


/* doxray
/* @docs
label: HTML5 Elements
note: |
Expand All @@ -184,7 +184,7 @@ article, aside, figcaption, figure, footer, header, hgroup, main, nav, section {
}


/* doxray
/* @docs
label: Checkbox & Radio Inputs
note: |
Expand Down
10 changes: 5 additions & 5 deletions css/reminders.css
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
/* doxray
/* @docs
label: Reminders
version: 0.1.0-beta.1
Expand All @@ -14,7 +14,7 @@ category: file
*/


/* doxray
/* @docs
label: List Style
note: |
Expand All @@ -31,7 +31,7 @@ category: navigation
} */


/* doxray
/* @docs
label: List Voiceover
note: |
Expand All @@ -49,7 +49,7 @@ category: navigation
} */


/* doxray
/* @docs
label: Reduced Motion
note: |
Expand All @@ -73,7 +73,7 @@ category: accessibility
} */


/* doxray
/* @docs
label: Line Heights
note: |
Expand Down

0 comments on commit 539392b

Please sign in to comment.