Clean up docs

This commit is contained in:
Neeraj Gupta 2023-11-29 14:08:56 +05:30
parent a93914511f
commit e486e55e60
7 changed files with 71 additions and 145 deletions

View file

@ -2,8 +2,8 @@ import { defineConfig } from 'vitepress'
// https://vitepress.dev/reference/site-config
export default defineConfig({
title: "Ente Photos Help",
description: "Ente Product Documentation",
title: "Ente Docs",
description: "Guide for ente.io apps",
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
nav: [
@ -28,10 +28,14 @@ export default defineConfig({
function sidebarphotos() {
return [
{
text: 'Examples',
text: 'Troubleshoot',
collapsed: true,
link: '/photos/troubleshooting/files-not-uploading',
items: [
{ text: 'Markdown Examples', link: '/markdown-examples' },
{ text: 'Runtime API Examples', link: '/api-examples' }
{ text: 'Files not uploading', link: '/photos/troubleshooting/files-not-uploading' },
{ text: 'Failed to play video', link: '/photos/troubleshooting/video-not-playing' },
{ text: 'Report bug', link: '/photos/troubleshooting/report-bug' },
]
},
{
@ -40,7 +44,7 @@ function sidebarphotos() {
{
text: 'Features',
collapsed: true,
// link: '/photos/features/',
link: '/photos/features/archive',
items: [
{ text: 'Archive', link: '/photos/features/archive' },
{ text: 'Hidden', link: '/photos/features/hidden' },
@ -63,11 +67,19 @@ function sidebarphotos() {
function sidebarAuth() {
return [
{
text: 'Examples',
items: [
{ text: 'Markdown Examples', link: '/markdown-examples' },
{ text: 'Runtime API Examples', link: '/api-examples' }
]
text: 'FAQ',
link: '/authenticator/faq/faq',
// items: [
// { text: 'Contribute', link: '/authenticator/support/contribute' },
// { text: 'Report bug', link: '/authenticator/contribute/report-bug' },
// ]
},
{
text: 'Contribute',
link: '/authenticator/support/contribute'
}
]
}

View file

@ -1,49 +0,0 @@
---
outline: deep
---
# Runtime API Examples
This page demonstrates usage of some of the runtime APIs provided by VitePress.
The main `useData()` API can be used to access site, theme, and page data for the current page. It works in both `.md` and `.vue` files:
```md
<script setup>
import { useData } from 'vitepress'
const { theme, page, frontmatter } = useData()
</script>
## Results
### Theme Data
<pre>{{ theme }}</pre>
### Page Data
<pre>{{ page }}</pre>
### Page Frontmatter
<pre>{{ frontmatter }}</pre>
```
<script setup>
import { useData } from 'vitepress'
const { site, theme, page, frontmatter } = useData()
</script>
## Results
### Theme Data
<pre>{{ theme }}</pre>
### Page Data
<pre>{{ page }}</pre>
### Page Frontmatter
<pre>{{ frontmatter }}</pre>
## More
Check out the documentation for the [full list of runtime APIs](https://vitepress.dev/reference/runtime-api#usedata).

View file

@ -0,0 +1,8 @@
## Translation
## Icons
## Support Development
If you wish to support the development of the project, please consider switching to paid plan of [Ente Photos](https://ente.io)

View file

@ -1,85 +0,0 @@
# Markdown Extension Examples
This page demonstrates some of the built-in markdown extensions provided by VitePress.
## Syntax Highlighting
VitePress provides Syntax Highlighting powered by [Shikiji](https://github.com/antfu/shikiji), with additional features like line-highlighting:
**Input**
````md
```js{4}
export default {
data () {
return {
msg: 'Highlighted!'
}
}
}
```
````
**Output**
```js{4}
export default {
data () {
return {
msg: 'Highlighted!'
}
}
}
```
## Custom Containers
**Input**
```md
::: info
This is an info box.
:::
::: tip
This is a tip.
:::
::: warning
This is a warning.
:::
::: danger
This is a dangerous warning.
:::
::: details
This is a details block.
:::
```
**Output**
::: info
This is an info box.
:::
::: tip
This is a tip.
:::
::: warning
This is a warning.
:::
::: danger
This is a dangerous warning.
:::
::: details
This is a details block.
:::
## More
Check out the documentation for the [full list of markdown extensions](https://vitepress.dev/guide/markdown).

View file

@ -0,0 +1,16 @@
## Network Issue
If you are using VPN, please try disabling the VPN or switching provider.
## Web/Desktop
**Certain file types are not uploading**
The desktop/web app tries to detect if a particular file is video or image. If the detection fails, then the app skips the upload.
Please share either the sample file or logs with us @support.ente.io
## Mobile

View file

@ -0,0 +1,16 @@
## Report Bug
Guide to help the user in sharing logs.
### Mobile
Placeholder
### Desktop
Placeholder
### Web
Placeholder

View file

@ -0,0 +1,8 @@
## Video Playback Issue
### Web
### Desktop / Mobile