Skip to content

Commit 3e1e42d

Browse files
authored
🔀 Merge pull request #1293 from wozboz/master
Fixed typos in documentation
2 parents 7669629 + a75afce commit 3e1e42d

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

docs/alternate-views.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ Dashy supports several different ways to launch your apps. The primary opening m
4747

4848
- `sametab` - The app will be launched in the current tab
4949
- `newtab` - The app will be launched in a new tab
50-
- `top` - Opens in the top-most browsing context, useful if your accessing Dashy through an iframe
50+
- `top` - Opens in the top-most browsing context, useful if you're accessing Dashy through an iframe
5151
- `modal` - Launch app in a resizable/ movable popup modal on the current page
5252
- `workspace` - Changes to Workspace view, and launches app
5353

docs/development-guides.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -313,7 +313,7 @@ export default {
313313
All widgets extend from the [Widget](https://github.com/Lissy93/dashy/blob/master/src/mixins/WidgetMixin.js) mixin. This provides some basic functionality that is shared by all widgets. The mixin includes the following `options`, `startLoading()`, `finishLoading()`, `error()` and `update()`.
314314

315315
- **Getting user options: `options`**
316-
- Any user-specific config can be accessed with `this.options.something` (where something is the data key your accessing)
316+
- Any user-specific config can be accessed with `this.options.something` (where something is the data key you're accessing)
317317
- **Loading state: `startLoading()` and `finishLoading()`**
318318
- You can show the loader with `this.startLoading()`, then when your data request completes, hide it again with `this.finishLoading()`
319319
- **Error handling: `error()`**
@@ -341,7 +341,7 @@ computed: {
341341

342342
#### **Adding an API Endpoint**
343343

344-
If your widget makes a data request, then add the URL for the API under point to the `widgetApiEndpoints` array in [`defaults.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/defaults.js#L207)
344+
If your widget makes a data request, then add the URL for the API endpoint to the `widgetApiEndpoints` array in [`defaults.js`](https://github.com/Lissy93/dashy/blob/master/src/utils/defaults.js#L207)
345345

346346
```javascript
347347
widgetApiEndpoints: {
@@ -410,7 +410,7 @@ Now that the results are in the correct format, and stored as data variables, we
410410

411411
#### **Styling**
412412

413-
Styles can be written your your widget within the `<style>` block.
413+
Styles can be written for your widget within the `<style>` block.
414414

415415
There are several color variables used by widgets, which extend from the base palette. Using these enables users to override colors to theme their dashboard, if they wish. The variables are: `--widget-text-color`, `--widget-background-color` and `--widget-accent-color`
416416

@@ -439,7 +439,7 @@ Here, the `example-widget` property name will be used to identify the widget whe
439439

440440
### Step 4 - Docs
441441

442-
Finally, add some documentation for your widget in the [Widget Docs](https://github.com/Lissy93/dashy/blob/master/docs/widgets.md), so that others know hoe to use it. Include the following information: Title, short description, screenshot, config options and some example YAML.
442+
Finally, add some documentation for your widget in the [Widget Docs](https://github.com/Lissy93/dashy/blob/master/docs/widgets.md), so that others know how to use it. Include the following information: Title, short description, screenshot, config options and some example YAML.
443443

444444
**Summary**: For a complete example of everything discussed here, see: [`3da76ce`](https://github.com/Lissy93/dashy/commit/3da76ce2999f57f76a97454c0276301e39957b8e)
445445

0 commit comments

Comments
 (0)