Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate documentation to VitePress and main GitHub Pages website #1314

Merged
merged 50 commits into from
Jul 26, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
50 commits
Select commit Hold shift + click to select a range
f6113aa
WIP
raucao Jun 18, 2024
0ca541d
Content
raucao Jun 28, 2024
e6d9cc3
Remove obsolete index
raucao Jun 28, 2024
5e178b6
Change folder structure, remove VitePress home page
raucao Jun 28, 2024
abf25a5
Menus, content
raucao Jun 28, 2024
b56244b
Sidebar
raucao Jun 28, 2024
57341d9
Add Caching doc, finish porting Access doc
raucao Jun 30, 2024
592de74
Remove auto-generated typdoc vitepress sidebar
raucao Jun 30, 2024
5555d68
Clean up doc/ folder
raucao Jun 30, 2024
4ea69ab
WIP Port getting-started docs
raucao Jun 30, 2024
9ab5bc4
Port why-use-this
raucao Jun 30, 2024
4226d95
WIP Port rest of documents, remove doc/ folder entirely
raucao Jun 30, 2024
53e2d43
WIP More documentation porting
raucao Jun 30, 2024
88078b7
Port Caching API doc
raucao Jun 30, 2024
8a48a5d
Update API docs build
raucao Jul 1, 2024
e351b7b
Update logo path
raucao Jul 1, 2024
4863898
Remove VitePress cache dir from repo
raucao Jul 2, 2024
420f165
Finish porting Getting Started pages
raucao Jul 3, 2024
fe7d054
WIP content
raucao Jul 3, 2024
77cbb2c
Update addModule docs, export RSModule interface/docs
raucao Jul 3, 2024
f37a772
WIP RemoteStorage API docs
raucao Jul 3, 2024
6dbd7d0
Move interface to documented class
raucao Jul 7, 2024
47b3588
Refactor exports/imports
raucao Jul 7, 2024
07ce11e
Documentation content, formatting
raucao Jul 7, 2024
eac0099
Update API docs output
raucao Jul 7, 2024
fb83687
Port Dropbox/GDrive doc
raucao Jul 7, 2024
84ecb0c
Fix wrong link being generated across different API docs
raucao Jul 9, 2024
669be2a
Port BaseClient API doc
raucao Jul 9, 2024
973bcd6
Update API docs
raucao Jul 9, 2024
0c72a1c
Remove obsolete API docs index page and menu link
raucao Jul 9, 2024
8e74111
Finish porting Contributing docs
raucao Jul 9, 2024
1f3da93
Update docs menu
raucao Jul 9, 2024
286448b
Finish porting Data Modules docs
raucao Jul 9, 2024
c7bcbbb
Update metadata for docs index
raucao Jul 9, 2024
5c2d9b3
Remove old documentation tasks
raucao Jul 22, 2024
28f0850
Remove obsolete script
raucao Jul 22, 2024
ade96fc
Fix usage with global variable
raucao Jul 22, 2024
f6ec2a3
Update gitignore
raucao Jul 22, 2024
9625dcb
Fix mocha test
raucao Jul 22, 2024
38a6797
Update typedoc and typescript eslint deps, fix linting
raucao Jul 22, 2024
ede44f1
Configure deep nesting for outline menu
raucao Jul 22, 2024
34c4a31
Fix typo
raucao Jul 22, 2024
6f00c54
Update docs build
raucao Jul 22, 2024
867c2c6
Update typedoc links
raucao Jul 22, 2024
584dba2
Update vitepress
raucao Jul 22, 2024
583d8f7
Don't add auto-generated typedoc index page to repo
raucao Jul 26, 2024
c867ce9
Finish getting-started doc for loading data on app startup
raucao Jul 26, 2024
a199c15
Mark optional argument as optional
raucao Jul 26, 2024
b33d632
Fix links, asset URLs
raucao Jul 26, 2024
4192f44
Update docs build
raucao Jul 26, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,12 @@ module.exports = {
"semi": 2,
"arrow-spacing": 2,
"no-prototype-builtins": 1,
"@typescript-eslint/ban-types": 1,
"@typescript-eslint/camelcase": 0,
"@typescript-eslint/no-explicit-any": 1,
"@typescript-eslint/no-var-requires": 1,
"@typescript-eslint/no-unsafe-declaration-merging": 1,
"@typescript-eslint/no-unused-vars": 1,
"@typescript-eslint/no-use-before-define": 1,
"@typescript-eslint/no-empty-interface": 1
},
Expand Down
6 changes: 3 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@
*.log
/build
/gitno
cache
node_modules
doc/code
doc/_build
doc/__pycache__/
tags
docs/api/index.md
docs/.vitepress/dist/
20 changes: 0 additions & 20 deletions doc/Makefile

This file was deleted.

11 changes: 0 additions & 11 deletions doc/_static/css/custom.css

This file was deleted.

5 changes: 0 additions & 5 deletions doc/_templates/layout.html

This file was deleted.

19 changes: 0 additions & 19 deletions doc/build-with-conda.sh

This file was deleted.

221 changes: 0 additions & 221 deletions doc/conf.py

This file was deleted.

18 changes: 0 additions & 18 deletions doc/contributing.rst

This file was deleted.

45 changes: 0 additions & 45 deletions doc/contributing/building.rst

This file was deleted.

Loading