mirror of
https://codeberg.org/VnPower/PixivFE
synced 2024-12-06 19:16:23 +01:00
docs: consolidate pages under Feature tracker
This commit is contained in:
perennial
@@ -1,6 +1,8 @@
|
||||
# Feature ideas
|
||||
# Feature tracker
|
||||
|
||||
This section contains some potential features or redesigns that can be implemented into PixivFE.
|
||||
This page tracks the implementation of features or redesigns in PixivFE.
|
||||
|
||||
Features with broader scope have their own detailed write-ups under the `dev/features` section.
|
||||
|
||||
## Pixivision
|
||||
|
||||
@@ -157,4 +159,55 @@ Notes
|
||||
|
||||
## Option to select default image quality in artwork page
|
||||
|
||||
## Pixiv App API
|
||||
|
||||
Besides the web API, Pixiv also has a private API made specifically for mobile applications.
|
||||
|
||||
There are currently no official API specifications for the private API, and the unofficial ones seem to lack several functionalities. We might have to write one.
|
||||
|
||||
Examples of implementations:
|
||||
|
||||
- [upbit/pixivpy (`aapi.py`)](https://github.com/upbit/pixivpy/blob/master/pixivpy3/aapi.py)
|
||||
- [book000/pixivts (`pixiv.ts`)](https://github.com/book000/pixivts/blob/master/src/pixiv.ts)
|
||||
|
||||
### Goal
|
||||
|
||||
- Separate the Web API core and the App API core, but make both of them compatible with each other.
|
||||
- Complications...
|
||||
|
||||
## Novels
|
||||
|
||||
This section tracks the implementation of features related to novels.
|
||||
|
||||
| Category | Feature | Status | Notes |
|
||||
|----------|---------|--------|-------|
|
||||
| Functions | Novel series | ✅ | Completed a while ago as of 2024-10-14, and implemented for the Bootstrap rewrite |
|
||||
| UI | Furigana support | ❌ | |
|
||||
| UI | Reader settings panel | ❌ | Completed a long time ago as of 2024-10-14, but the Bootstrap rewrite has a buggy/unstable implementation |
|
||||
| UI | Novel page with vertical text if `body.suggestedSettings.viewMode == 1` | ❌ | Completed a long time ago as of 2024-10-14, but the Bootstrap rewrite has a buggy/unstable implementation |
|
||||
| UI | Attributes | ❌ | |
|
||||
| UI | Recent novels from writers | ✅ | Completed during the Bootstrap rewrite, but has incomplete data from the Pixiv API |
|
||||
| UI | Page support | ❌ | |
|
||||
| UI | Recommended novels | ✅ | Completed a long time ago as of 2024-10-14 |
|
||||
| UI | Other works panel? | ❌ | |
|
||||
| Misc | Novel ranking | ❌ | |
|
||||
| Misc | Novel mode for any possible pages | ❌ | |
|
||||
|
||||
## Per-User Customization Options
|
||||
|
||||
Probably cookie-based.
|
||||
|
||||
### site-wide
|
||||
|
||||
- [ ] sidebar close on history change or not [#63](https://codeberg.org/VnPower/PixivFE/issues/63)
|
||||
- [ ] navbar sticky or not
|
||||
|
||||
### artwork
|
||||
- [ ] native AI/R15/R18/R18-G... artwork filtering
|
||||
We can filter them out using values supplied by Pixiv for each artworks.
|
||||
|
||||
### search
|
||||
- [ ] add an option to do potentially very extensive searches
|
||||
Sort by bookmarks
|
||||
|
||||
[^1]: No pun intended.
|
||||
@@ -1,15 +0,0 @@
|
||||
# Pixiv App API
|
||||
|
||||
Besides the web API, Pixiv also has a private API made specifically for mobile applications.
|
||||
|
||||
There are currently no official API specifications for the private API, and the unofficial ones seem to lack several functionalities. We might have to write one.
|
||||
|
||||
Examples of implementations:
|
||||
|
||||
- [upbit/pixivpy (`aapi.py`)](https://github.com/upbit/pixivpy/blob/master/pixivpy3/aapi.py)
|
||||
- [book000/pixivts (`pixiv.ts`)](https://github.com/book000/pixivts/blob/master/src/pixiv.ts)
|
||||
|
||||
## Goal
|
||||
|
||||
- Separate the Web API core and the App API core, but make both of them compatible with each other.
|
||||
- Complications...
|
||||
@@ -1,3 +1,5 @@
|
||||
# Caching
|
||||
|
||||
I thought about caching a little bit.
|
||||
|
||||
## Guide for caching
|
||||
@@ -7,7 +9,7 @@ The majority of the site's traffic is images, and all images on the Pixiv route
|
||||
On the server, the reverse proxy (e.g. nginx) can be cached worry-free forever.
|
||||
|
||||
JSON requests to Pixiv can be cached for some time.
|
||||
todo: We should have a middleware handling that.
|
||||
todo: We should have a middleware handling that.
|
||||
|
||||
Assets are already cached properly thanks to net/http.
|
||||
|
||||
|
||||
@@ -1,17 +0,0 @@
|
||||
# Novels
|
||||
|
||||
This page covers the implementation of features related to novels.
|
||||
|
||||
| Category | Feature | Status | Notes |
|
||||
|----------|---------|--------|-------|
|
||||
| Functions | Novel series | ✅ | Completed a while ago as of 2024-10-14, and implemented for the Bootstrap rewrite |
|
||||
| UI | Furigana support | ❌ | |
|
||||
| UI | Reader settings panel | ❌ | Completed a long time ago as of 2024-10-14, but the Bootstrap rewrite has a buggy/unstable implementation |
|
||||
| UI | Novel page with vertical text if `body.suggestedSettings.viewMode == 1` | ❌ | Completed a long time ago as of 2024-10-14, but the Bootstrap rewrite has a buggy/unstable implementation |
|
||||
| UI | Attributes | ❌ | |
|
||||
| UI | Recent novels from writers | ✅ | Completed during the Bootstrap rewrite, but has incomplete data from the Pixiv API |
|
||||
| UI | Page support | ❌ | |
|
||||
| UI | Recommended novels | ✅ | Completed a long time ago as of 2024-10-14 |
|
||||
| UI | Other works panel? | ❌ | |
|
||||
| Misc | Novel ranking | ❌ | |
|
||||
| Misc | Novel mode for any possible pages | ❌ | |
|
||||
@@ -1,16 +0,0 @@
|
||||
# Per-User Customization Options
|
||||
|
||||
Probably cookie-based.
|
||||
|
||||
## site-wide
|
||||
|
||||
- [ ] sidebar close on history change or not [#63](https://codeberg.org/VnPower/PixivFE/issues/63)
|
||||
- [ ] navbar sticky or not
|
||||
|
||||
## artwork
|
||||
- [ ] native AI/R15/R18/R18-G... artwork filtering
|
||||
We can filter them out using values supplied by Pixiv for each artworks.
|
||||
|
||||
## search
|
||||
- [ ] add an option to do potentially very extensive searches
|
||||
Sort by bookmarks
|
||||
+5
-4
@@ -17,7 +17,7 @@ nav:
|
||||
- "dev/index.md" # Leave without title
|
||||
- "Coding tips": "dev/coding-tips.md"
|
||||
- "Design flaws": "dev/design-flaws.md"
|
||||
- "Feature ideas": "dev/feature-ideas.md"
|
||||
- "Feature tracker": "dev/feature-tracker.md"
|
||||
- "Guidelines": "dev/guidelines.md"
|
||||
- "Helpful resources": "dev/helpful-resources.md"
|
||||
- "Roadmap": "dev/roadmap.md"
|
||||
@@ -25,10 +25,7 @@ nav:
|
||||
- "Features":
|
||||
- "Exponential backoff": "dev/features/exponential_backoff.md"
|
||||
- "Caching": "dev/features/caching.md"
|
||||
- "Novels": "dev/features/novels.md"
|
||||
- "Tracing flamegraph": "dev/features/tracing-flamegraph.md"
|
||||
- "User customization": "dev/features/user-customization.md"
|
||||
- "Pixiv app API": "dev/features/app-api.md"
|
||||
- "Internationalization": "dev/features/i18n.md"
|
||||
- "Archive":
|
||||
- "Framework migration": "dev/archive/framework-migration.md"
|
||||
@@ -136,6 +133,10 @@ plugins:
|
||||
'hosting-pixivfe.md': 'hosting/hosting-pixivfe.md'
|
||||
'hosting-image-proxy-server.md': 'hosting/image-proxy-server.md'
|
||||
'obtaining-pixivfe-token.md': 'hosting/obtaining-pixivfe-token.md'
|
||||
'dev/feature-ideas.md': 'dev/feature-tracker.md'
|
||||
'dev/features/novels.md': 'dev/feature-tracker.md'
|
||||
'dev/features/user-customization.md': 'dev/feature-tracker.md'
|
||||
'dev/features/app-api.md': 'dev/feature-tracker.md'
|
||||
# Archived documents
|
||||
'dev/framework-migration.md': 'dev/archive/framework-migration.md'
|
||||
|
||||
|
||||
Reference in New Issue
Block a user