Skip to content

Commit

Permalink
fixdoc(): main entry filename
Browse files Browse the repository at this point in the history
Signed-off-by: dankeboy36 <[email protected]>
  • Loading branch information
dankeboy36 committed Jan 5, 2024
1 parent 713d5f3 commit bfeb370
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 11 deletions.
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,3 @@ node_modules
src/test/test-workspace/*
!src/test/test-workspace/.gitkeep
.nyc_output
docs/README.md
16 changes: 8 additions & 8 deletions docs/modules.md → docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,17 @@

### Type Aliases

- [BoardIdentifier](modules.md#boardidentifier)
- [BuildProperties](modules.md#buildproperties)
- [Tool](modules.md#tool)
- [Version](modules.md#version)
- [BoardIdentifier](README.md#boardidentifier)
- [BuildProperties](README.md#buildproperties)
- [Tool](README.md#tool)
- [Version](README.md#version)

### Variables

- [ConfigOption](modules.md#configoption)
- [ConfigValue](modules.md#configvalue)
- [Port](modules.md#port)
- [Programmer](modules.md#programmer)
- [ConfigOption](README.md#configoption)
- [ConfigValue](README.md#configvalue)
- [Port](README.md#port)
- [Programmer](README.md#programmer)

## Type Aliases

Expand Down
2 changes: 1 addition & 1 deletion docs/interfaces/SketchFolder.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The current state in the sketch folder. For example, the FQBN of the selected bo

### board

`Readonly` **board**: `undefined` \| [`BoardIdentifier`](../modules.md#boardidentifier) \| [`BoardDetails`](BoardDetails.md)
`Readonly` **board**: `undefined` \| [`BoardIdentifier`](../README.md#boardidentifier) \| [`BoardDetails`](BoardDetails.md)

The currently selected board associated with the sketch. If the `board` is undefined, no board is selected.
If the `board` is a `BoardIdentifier`, it could be a recognized board on a detected port, but the board's platform could be absent.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"clean": "rimraf dist out *.vsix",
"compile": "webpack && vsce package",
"compile-tests": "tsc -p . --outDir out",
"doc": "typedoc --plugin typedoc-plugin-markdown --hideBreadcrumbs true --disableSources --out docs ./src/api.ts",
"doc": "typedoc --plugin typedoc-plugin-markdown --readme none --hideBreadcrumbs true --disableSources --out docs ./src/api.ts",
"postdoc": "prettier --write ./docs",
"format": "prettier --write .",
"lint": "eslint src --ext ts",
Expand Down

0 comments on commit bfeb370

Please sign in to comment.