railbird/react-native-vision-camera
9
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix docs broken links (#97)

Browse Source 
* Fix broken CameraProps.format link

* Use absolute urls for SETUP.mdx
This commit is contained in:
Marc Rousavy 2021-03-23 15:49:58 +01:00 committed by GitHub
parent 6df988d5f3
commit f0828e63f0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 4 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/docs/INDEX.mdx
View File

@ -1,32 +0,0 @@
---
id: index
title: Welcome to the VisionCamera documentation!
sidebar_label: Welcome
slug: /
---
import useBaseUrl from '@docusaurus/useBaseUrl';
<div>
<img align="right" width="283" src={useBaseUrl("img/example_intro.png")} />
</div>
**Quick Links**
* [Guides](./guides/)
* [API](./api/)
* [Example](https://github.com/cuvent/react-native-vision-camera/tree/main/example)
<a href="https://cuvent.com"><img height="40" src={useBaseUrl("img/cuvent-logo-text.svg")} /></a>
<br/>
<a align="center" href="https://github.com/mrousavy?tab=followers">
<img src="https://img.shields.io/github/followers/mrousavy?label=Follow%20%40mrousavy&style=social" />
</a>
<br />
<a align="center" href="https://twitter.com/mrousavy">
<img src="https://img.shields.io/twitter/follow/mrousavy?label=Follow%20%40mrousavy&style=social" />
</a>
<br/>
<a align="center" href="https://twitter.com/cuventtech">
<img src="https://img.shields.io/twitter/follow/cuventtech?label=Follow%20%40cuventtech&style=social" />
</a>

6
docs/docs/guides/SETUP.mdx
View File

@ -51,7 +51,7 @@ Also, make sure you're using Swift 5.2 or above:
2. If the `LIBRARY_SEARCH_PATH` value is set, make sure there is no explicit reference to Swift-5.0. If there is, remove it. See [this StackOverflow answer](https://stackoverflow.com/a/66281846/1123156). 2. If the `LIBRARY_SEARCH_PATH` value is set, make sure there is no explicit reference to Swift-5.0. If there is, remove it. See [this StackOverflow answer](https://stackoverflow.com/a/66281846/1123156).
3. If the `SWIFT_VERSION` value is set, make sure it is set to `5.2` or higher. 3. If the `SWIFT_VERSION` value is set, make sure it is set to `5.2` or higher.
> See [Troubleshooting](troubleshooting) if you're having problems > See [Troubleshooting](/docs/guides/troubleshooting) if you're having problems
### Android ### Android
@ -75,7 +75,7 @@ compileSdkVersion = 30
targetSdkVersion = 30 targetSdkVersion = 30
``` ```
> See [Troubleshooting](troubleshooting) if you're having problems > See [Troubleshooting](/docs/guides/troubleshooting) if you're having problems
## Permissions ## Permissions
@ -117,4 +117,4 @@ The permission request status can have the following values:
<br /> <br />
#### 🎉 Hooray! You're ready to learn about [Camera Devices](devices)! #### 🎉 Hooray! You're ready to learn about [Camera Devices](/docs/guides/devices)!

2
src/CameraDevice.ts
View File

@ -211,7 +211,7 @@ export interface CameraDevice {
*/ */
neutralZoom: number; neutralZoom: number;
/** /**
* All available formats for this camera device. Use this to find the best format for your use case and set it to the Camera's {@linkcode Camera.format} property. * All available formats for this camera device. Use this to find the best format for your use case and set it to the Camera's {@linkcode CameraProps.format | Camera's .format} property.
* *
* See [the Camera Formats documentation](https://cuvent.github.io/react-native-vision-camera/docs/guides/formats) for more information about Camera Formats. * See [the Camera Formats documentation](https://cuvent.github.io/react-native-vision-camera/docs/guides/formats) for more information about Camera Formats.
*/ */