diff options
| -rw-r--r-- | README.md | 97 | ||||
| -rw-r--r-- | docs/_templates/extralinks.html | 7 | ||||
| -rw-r--r-- | docs/conf.py | 11 |
3 files changed, 31 insertions, 84 deletions
@@ -1,100 +1,31 @@  An *experimental* Fediverse server for microblogging/"toots". Not fully functional yet - -I'm still working on making all the basic bits work! For more background and information, -see [jointakahe.org](https://jointakahe.org/). +we're still working towards a 1.0! +Key features: +- Multiple domain support +- Multiple identities per user (and can be shared between users) +- Desktop, mobile and PWA-compatible web UI (with minimal JavaScript) +- Easy deployment (web worker, background worker, and one database) -## Deployment - -See [the documentation](https://takahe-server.readthedocs.io) - -## Roadmap +For more background and information, see [jointakahe.org](https://jointakahe.org/). -Takahē is still under very active development towards something I'm willing to -call a beta. I've grouped features here into milestones, along with if they're -done yet or not. None of this is final, and the further into the future it is, -the less sure I am about it. -### Alpha - -- [x] Create posts -- [x] Set post visibility -- [x] Receive posts -- [x] Handle received post visibility (unlisted vs public only) -- [x] Receive post deletions -- [x] Receive post edits -- [x] Set content warnings on posts -- [x] Show content warnings on posts -- [x] Receive images on posts -- [x] Receive reply info -- [x] Create boosts -- [x] Receive boosts -- [x] Create likes -- [x] Receive likes -- [x] Create follows -- [x] Undo follows -- [x] Receive and accept follows -- [x] Receive follow undos -- [x] Do outgoing mentions properly -- [x] Home timeline (posts and boosts from follows) -- [x] Notifications page (followed, boosted, liked) -- [x] Local timeline -- [x] Federated timeline -- [x] Profile pages -- [x] Settable icon and background image for profiles -- [x] User search -- [x] Following page -- [x] Followers page -- [x] Multiple domain support -- [x] Multiple identity support -- [x] Serverless-friendly worker subsystem -- [x] Settings subsystem -- [x] Server management page -- [x] Domain management page -- [x] Email subsystem -- [x] Signup flow -- [x] Password reset flow +## Deployment -### Beta +See [our deployment documentation](https://takahe-server.readthedocs.io/en/latest/installation/) -- [ ] Attach images to posts -- [ ] Edit posts -- [ ] Delete posts -- [ ] Password change flow -- [ ] Fetch remote post images locally and thumbnail -- [ ] Show follow pending states -- [ ] Manual approval of followers -- [ ] Reply threading on post creation -- [ ] Display posts with reply threads -- [ ] Create polls on posts -- [ ] Receive polls on posts -- [ ] Emoji fetching and display -- [ ] Emoji creation -- [ ] Image descriptions -- [ ] Hashtag search -- [ ] Flag for moderation -- [ ] Moderation queue -- [ ] User management page -- [ ] Server defederation -- [ ] Filters for posts/boosts -- [ ] OAuth subsystem -### 1.0 +## Roadmap -- [ ] IP banning -- [ ] Trends subsystem and moderation -- [ ] Server announcements -- [ ] Automated post deletion -- [ ] Post popularity system (for long gaps between timeline views) -- [ ] Mastodon client API +Takahē is still under very active development towards a 1.0 release, and not +all functionality is supported yet. -### Future +For a detailed feature breakdown, see [the features page in our docs](https://takahe-server.readthedocs.io/en/latest/features/). -- [ ] Relays? -- [ ] Mastodon backup import? (would need url mapping for actors) ## Contributing -If you'd like to contribute, please read [CONTRIBUTING.md](./CONTRIBUTING.md). +If you'd like to contribute, please read [our contributing docs](https://takahe-server.readthedocs.io/en/latest/contributing/). diff --git a/docs/_templates/extralinks.html b/docs/_templates/extralinks.html new file mode 100644 index 0000000..e8a0f35 --- /dev/null +++ b/docs/_templates/extralinks.html @@ -0,0 +1,7 @@ +<h3>Takahē</h3> +<ul> + <li><a href="https://jointakahe.org">Homepage</a></li> + <li><a href="https://takahe-server.readthedocs.io/">Documentation</a></li> + <li><a href="https://github.com/jointakahe/takahe">GitHub</a></li> + <li><a href="https://discord.gg/qvQ39tAMvf">Discord</a></li> +</ul> diff --git a/docs/conf.py b/docs/conf.py index 73e4692..480b95b 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -22,5 +22,14 @@ exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output -html_theme = "alabaster" +html_theme = "nature" html_static_path = ["_static"] +html_logo = "../static/img/logo-128.png" +html_favicon = "../static/img/icon-32.png" +html_sidebars = { + "**": [ + "localtoc.html", + "extralinks.html", + "searchbox.html", + ] +} |