Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Mar0xy committed Nov 29, 2023
1 parent b747bd1 commit dc521d6
Show file tree
Hide file tree
Showing 24 changed files with 371 additions and 515 deletions.
4 changes: 2 additions & 2 deletions config/_default/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ disableKinds = ["sitemap"]

# Multilingual
defaultContentLanguage = "en"
disableLanguages = ["de", "nl"]
disableLanguages = ["de"]
# defaultContentLanguageInSubdir = true

# add redirects/headers
Expand Down Expand Up @@ -63,7 +63,7 @@ notAlternative = true
tag = "tags"

[permalinks]
blog = "/blog/:title/"
# blog = "/blog/:title/"
# docs = "/docs/1.0/:sections[1:]/:title/"

[minify.tdewolff.html]
Expand Down
8 changes: 4 additions & 4 deletions config/_default/menus/menus.en.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[[main]]
name = "Docs"
url = "/docs"
weight = 10
#[[main]]
# name = "Docs"
# url = "/docs/install/fresh"
# weight = 10

[[social]]
name = "GitHub"
Expand Down
2 changes: 1 addition & 1 deletion config/_default/params.toml
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ defaultImage = "default-image.png" # put in `./assets/images/`
fillImage = "1270x740 Center" # normalize image size

# Footer
footer = "Powered by <a class=\"text-muted\" href=\"https://www.netlify.com/\">Netlify</a>, <a class=\"text-muted\" href=\"https://gohugo.io/\">Hugo</a>, and <a class=\"text-muted\" href=\"https://getdoks.org/\">Doks</a>"
footer = "Powered by <a class=\"text-muted\" href=\"https://pages.github.com/\">Github Pages</a>, <a class=\"text-muted\" href=\"https://gohugo.io/\">Hugo</a>, and <a class=\"text-muted\" href=\"https://getdoks.org/\">Doks</a>"

# Feed
copyRight = "Copyright (c) 2022-2023 Transfem-org"
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title : "Docs"
description: "Docs Doks."
description: "Docs."
lead: ""
date: 2020-10-06T08:48:23+00:00
lastmod: 2020-10-06T08:48:23+00:00
Expand Down
5 changes: 5 additions & 0 deletions content/en/docs/comparsion/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "Comparsion"
weight: 2000
toc: true
---
83 changes: 83 additions & 0 deletions content/en/docs/comparsion/misskey.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
title: "Sharkey vs Misskey"
weight: 2100
toc: true
---

## A (probably comprehensive) list of differences

### Big ones

* fully federated note editing, you can also see previous versions of
edited notes
* Mastodon-compatible API, including OAuth2
* can import your exported posts from Mastodon and most of its forks,
Pleroma / Akkoma, Misskey / Firefish and forks, Twitter, Instagram,
Facebook, including attachments (threading may not work perfectly,
and other people's replies to your posts may not get imported)
* admins can require approval for new users' signups
* admins can silence users
* admins can mark all of a user's media as NSFW
* GDPR-style Data Subject Access Requests (users can export all data
related to themselves)

### Fun ones

* can play module / tracker music files
* (federated) listenbrainz integration
* (federated) background image on user profiles
* "speak as cat" separate from "is a cat" (both setting are federated
with compatible software)

### UI/UX

* option to open a note's detailed view by clicking on the note (most
useful on mobile)
* images lacking alt text are marked as such
* UI elements can be round (as in Misskey) or square-ish
* "sign out" button in user menu
* user profile page has "notes" / "all" / "including files" tabs
* attachments can be collapsed by default
* buttons to show/hide all notes with CWs in a conversation
* one-button "like" (plus custom reactions on a separate button)
* animated MFM can be enabled/disabled on each note
* supports longer alt text
* pop-up user profiles show if follow requests to the user require
approval, have a "open remote profile" option, and show custom
fields (e.g. the user's website address)
* MFM cheatsheet when composing notes
* emoji auto-complete is case-insensitive
* it's always clear if a note has a poll (misskey sometimes hides
that)
* boosts and quote-boost are accounted separately
* only 1 boost per note per user is allowed
* admins can remove bots from "trending"
* users can hide bots from their timelines
* translatable notes are shown translated regardless of where they're
shown (e.g. when quoted, or when looking at their replies)
* when searching, users can restrict results to notes with attachments
* CSS class names are human-readable, to simplify browser-side
customisation
* users can disable indexing of their notes (the setting is federated)
* "likes" and "reactions" federate correctly to Mastodon / Pleroma /
Akkoma (Misskey sends them all as reactions)
* different error icons
* users can disable the "disconnected" warning (connection is usually
re-established automatically, so the warning is rarely useful)
* users can set a default emoji for their likes/reactions
* when the instance is using meilisearch to index notes, Sharkey will
use it in more cases (e.g. when limiting results to notes containing
images)
* when showing a reply containing many mentions, they are shortened

### Ones of interest to admins

* quote-boosts federate correctly from/to Mastodon forks
* the not-very-functional "automatically mark attachments as NSFW" has
been removed (smaller installation, faster image/video uploads)
* argon2 instead of bcrypt for hashing users' secrets
* admins can delete remote emojis
* admins can disable achievements
* admins can refresh remote user details
* admins can set a default emoji for likes/reactions
* the PWA icon matches the instance icon
10 changes: 0 additions & 10 deletions content/en/docs/help/_index.md

This file was deleted.

50 changes: 0 additions & 50 deletions content/en/docs/help/faq.md

This file was deleted.

32 changes: 0 additions & 32 deletions content/en/docs/help/how-to-update.md

This file was deleted.

30 changes: 0 additions & 30 deletions content/en/docs/help/troubleshooting.md

This file was deleted.

5 changes: 5 additions & 0 deletions content/en/docs/install/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
title: "Install"
weight: 1000
toc: true
---
Loading

0 comments on commit dc521d6

Please sign in to comment.