diff --git a/docs/docs/CONFIGURATION.md b/docs/docs/CONFIGURATION.md index d7b25802..4414f6de 100644 --- a/docs/docs/CONFIGURATION.md +++ b/docs/docs/CONFIGURATION.md @@ -1,15 +1,15 @@ -# Pleroma-FE configuration and customization for instance administrators +# Akkoma-FE configuration and customization for instance administrators -* *For user configuration, see [Pleroma-FE user guide](../user_guide)* +* *For user configuration, see [Akkoma-FE user guide](../user_guide)* * *For local development server configuration, see [Hacking, tweaking, contributing](HACKING.md)* ## Where configuration is stored -PleromaFE gets its configuration from several sources, in order of preference (the one above overrides ones below it) +Akkoma-FE gets its configuration from several sources, in order of preference (the one above overrides ones below it) -1. `/api/statusnet/config.json` - this is generated on Backend and contains multiple things including instance name, char limit etc. It also contains FE/Client-specific data, PleromaFE uses `pleromafe` field of it. For more info on changing config on BE, look [here](https://docs.akkoma.dev/stable/configuration/cheatsheet.md#frontend_configurations) -2. `/static/config.json` - this is a static FE-provided file, containing only FE specific configuration. This file is completely optional and could be removed but is useful as a fallback if some configuration JSON property isn't present in BE-provided config. It's also a reference point to check what default configuration are and what JSON properties even exist. In local dev mode it could be used to override BE configuration, more about that in HACKING.md. File is located [here](https://akkoma.dev/AkkomaGang/pleroma-fe/src/branch/develop/static/config.json). -3. Built-in defaults. Those are hard-coded defaults that are used when `/static/config.json` is not available and BE-provided configuration JSON is missing some JSON properties. ( [Code](https://akkoma.dev/AkkomaGang/pleroma-fe/src/branch/develop/src/modules/instance.js) ) +1. `/api/statusnet/config.json` - this is generated on Backend and contains multiple things including instance name, char limit etc. It also contains FE/Client-specific data, Akkoma-FE uses `pleromafe` field of it. For more info on changing config on BE, look [here](https://docs.akkoma.dev/stable/configuration/cheatsheet.md#frontend_configurations) +2. `/static/config.json` - this is a static FE-provided file, containing only FE specific configuration. This file is completely optional and could be removed but is useful as a fallback if some configuration JSON property isn't present in BE-provided config. It's also a reference point to check what default configuration are and what JSON properties even exist. In local dev mode it could be used to override BE configuration, more about that in HACKING.md. File is located [here](https://akkoma.dev/AkkomaGang/akkoma-fe/src/branch/develop/static/config.json). +3. Built-in defaults. Those are hard-coded defaults that are used when `/static/config.json` is not available and BE-provided configuration JSON is missing some JSON properties. ( [Code](https://akkoma.dev/AkkomaGang/akkoma-fe/src/branch/develop/src/modules/instance.js) ) ## Instance-defaults @@ -59,7 +59,7 @@ Instance `logo`, could be any image, including svg. By default it assumes logo u `logoMargin` allows you to adjust vertical margins between logo boundary and navbar borders. The idea is that to have logo's image without any extra margins and instead adjust them to your need in layout. ### `minimalScopesMode` -Limit scope selection to *Direct*, *User default* and *Scope of post replying to*. This also makes it impossible to reply to a DM with a non-DM post from PleromaFE. +Limit scope selection to *Direct*, *User default* and *Scope of post replying to*. This also makes it impossible to reply to a DM with a non-DM post from Akkoma-FE. ### `nsfwCensorImage` Use custom image for NSFW'd images @@ -77,7 +77,7 @@ Change alignment of sidebar and panels to the right. Defaults to `false`. Show panel showcasing instance features/settings to logged-out visitors ### `showInstanceSpecificPanel` -This allows you to include arbitrary HTML content in a panel below navigation menu. PleromaFE looks for an html page `instance/panel.html`, by default it's not provided in FE, but BE bundles some [default one](https://git.pleroma.social/pleroma/pleroma/blob/develop/priv/static/instance/panel.html). De-facto instance-defaults, since user can hide instance-specific panel. +This allows you to include arbitrary HTML content in a panel below navigation menu. Akkoma-FE looks for an html page `instance/panel.html`, by default it's not provided in FE, but BE bundles some [default one](https://git.pleroma.social/pleroma/pleroma/blob/develop/priv/static/instance/panel.html). De-facto instance-defaults, since user can hide instance-specific panel. ### `subjectLineBehavior` How to handle subject line (CW) when replying to a post. diff --git a/docs/docs/HACKING.md b/docs/docs/HACKING.md index 4cabb9bf..753fbccb 100644 --- a/docs/docs/HACKING.md +++ b/docs/docs/HACKING.md @@ -1,8 +1,8 @@ # Hacking, tweaking, contributing -## What PleromaFE even is, how it works +## What Akkoma-FE even is, how it works -PleromaFE is an SPA (Single-Page Application) backed by [Vue](https://vuejs.org/) framework. It means that it's just a nearly-empty HTML page with bunch of JavaScript that actually generates and controls DOM (i.e. html elements) in Runtime. Currently, there's no way around it - you have to have Javascript enabled in the browser to make it work, there is a theoretical possibility to generate some HTML server-side but it's not implemented yet. +Akkoma-FE is an SPA (Single-Page Application) backed by [Vue](https://vuejs.org/) framework. It means that it's just a nearly-empty HTML page with bunch of JavaScript that actually generates and controls DOM (i.e. html elements) in Runtime. Currently, there's no way around it - you have to have Javascript enabled in the browser to make it work, there is a theoretical possibility to generate some HTML server-side but it's not implemented yet. You can serve static html page and everything from any HTTP(S) server but currently it will try to access /api/ path at same domain it's running on, meaning that as of right now you cannot put it on one domain and access the other without proxying requests. @@ -67,19 +67,19 @@ server { ### API, Data, Operations -In 99% cases PleromaFE uses [MastoAPI](https://docs.joinmastodon.org/api/) with [Pleroma Extensions](https://docs.akkoma.dev/stable/differences_in_mastoapi_responses.md) to fetch the data. The rest is either QvitterAPI leftovers or pleroma-exclusive APIs. QvitterAPI doesn't exactly have documentation and uses different JSON structure and sometimes different parameters and workflows, [this](https://twitter-api.readthedocs.io/en/latest/index.html) could be a good reference though. Some pleroma-exclusive API may still be using QvitterAPI JSON structure. +In 99% cases Akkoma-FE uses [MastoAPI](https://docs.joinmastodon.org/api/) with [Pleroma Extensions](https://docs.akkoma.dev/stable/differences_in_mastoapi_responses.md) to fetch the data. The rest is either QvitterAPI leftovers or pleroma-exclusive APIs. QvitterAPI doesn't exactly have documentation and uses different JSON structure and sometimes different parameters and workflows, [this](https://twitter-api.readthedocs.io/en/latest/index.html) could be a good reference though. Some pleroma-exclusive API may still be using QvitterAPI JSON structure. -PleromaFE supports both formats by transforming them into internal format which is basically QvitterAPI one with some additions and renaming. All data is passed trough [Entity Normalizer](https://git.pleroma.social/pleroma/pleroma-fe/-/blob/develop/src/services/entity_normalizer/entity_normalizer.service.js) which can serve as a reference of API and what's actually used, it's also a host for all the hacks and data transformation. +Akkoma-FE supports both formats by transforming them into internal format which is basically QvitterAPI one with some additions and renaming. All data is passed trough [Entity Normalizer](https://akkoma.dev/AkkomaGang/akkoma-fe/src/branch/develop/src/services/entity_normalizer/entity_normalizer.service.js) which can serve as a reference of API and what's actually used, it's also a host for all the hacks and data transformation. -For most part, PleromaFE tries to store all the info it can get in global vuex store - every user and post are passed trough updating mechanism where data is either added or merged with existing data, reactively updating the information throughout UI, so if in newest request user's post counter increased, it will be instantly updated in open user profile cards. This is also used to find users, posts and sometimes to build timelines and/or request parameters. +For most part, Akkoma-FE tries to store all the info it can get in global vuex store - every user and post are passed trough updating mechanism where data is either added or merged with existing data, reactively updating the information throughout UI, so if in newest request user's post counter increased, it will be instantly updated in open user profile cards. This is also used to find users, posts and sometimes to build timelines and/or request parameters. -PleromaFE also tries to persist this store, however only stable data is stored, such as user authentication and preferences, user highlights. Persistence is performed by saving and loading chunk of vuex store in browser's LocalStorage/IndexedDB. +Akkoma-FE also tries to persist this store, however only stable data is stored, such as user authentication and preferences, user highlights. Persistence is performed by saving and loading chunk of vuex store in browser's LocalStorage/IndexedDB. TODO: Refactor API code and document it here ### Themes -PleromaFE uses custom theme "framework" which is pretty much just a style tag rendered by vue which only contains CSS3 variables. Every color used in UI should be derived from theme. Theme is stored in a JSON object containing color, opacity, shadow and font information, with most of it being optional. +Akkoma-FE uses custom theme "framework" which is pretty much just a style tag rendered by vue which only contains CSS3 variables. Every color used in UI should be derived from theme. Theme is stored in a JSON object containing color, opacity, shadow and font information, with most of it being optional. The most basic theme can consist of 4 to 8 "basic colors", which is also what previous version of themes allowed, with all other colors being derived from those basic colors, i.e. "light background" will be "background" color lightened/darkened, "panel header" will be same as "foreground". The idea is that you can specify just basic color palette and everything else will be generated automatically, but if you really need to tweak some specific color - you can. diff --git a/docs/docs/assets/example_emoji.png b/docs/docs/assets/example_emoji.png index 0a22a256..002c34c1 100644 Binary files a/docs/docs/assets/example_emoji.png and b/docs/docs/assets/example_emoji.png differ diff --git a/docs/docs/images/akkoma_logo_vector_bg_32.png b/docs/docs/images/akkoma_logo_vector_bg_32.png new file mode 100644 index 00000000..002c34c1 Binary files /dev/null and b/docs/docs/images/akkoma_logo_vector_bg_32.png differ diff --git a/docs/docs/images/akkoma_logo_vector_nobg.svg b/docs/docs/images/akkoma_logo_vector_nobg.svg new file mode 100644 index 00000000..1fdf5825 --- /dev/null +++ b/docs/docs/images/akkoma_logo_vector_nobg.svg @@ -0,0 +1,24 @@ + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/docs/images/pleroma_logo_vector_bg_32.png b/docs/docs/images/pleroma_logo_vector_bg_32.png deleted file mode 100644 index 7cebcfd7..00000000 Binary files a/docs/docs/images/pleroma_logo_vector_bg_32.png and /dev/null differ diff --git a/docs/docs/images/pleroma_logo_vector_nobg.svg b/docs/docs/images/pleroma_logo_vector_nobg.svg deleted file mode 100644 index 6dd80260..00000000 --- a/docs/docs/images/pleroma_logo_vector_nobg.svg +++ /dev/null @@ -1,92 +0,0 @@ - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - diff --git a/docs/docs/index.md b/docs/docs/index.md index d446fb29..de30dc3c 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -1,8 +1,8 @@ -# Introduction to Pleroma-FE -## What is Pleroma-FE? +# Introduction to Akkoma-FE +## What is Akkoma-FE? -Pleroma-FE is the default user-facing frontend for Pleroma. It's user interface is modeled after Qvitter which is modeled after an older Twitter design. It provides a simple 2-column interface for microblogging. While being simple by default it also provides many powerful customization options. +Akkoma-FE is the default user-facing frontend for Pleroma. It's user interface is modeled after Qvitter which is modeled after an older Twitter design. It provides a simple 2-column interface for microblogging. While being simple by default it also provides many powerful customization options. ## How can I use it? -If your instance uses Pleroma-FE, you can acces it by going to your instance (e.g. ). You can read more about it's basic functionality in the [Pleroma-FE User Guide](./user_guide/). We also have [a guide for administrators](./CONFIGURATION.md) and for [hackers/contributors](./HACKING.md). +If your instance uses Akkoma-FE, you can acces it by going to your instance (e.g. ). You can read more about it's basic functionality in the [Akkoma-FE User Guide](./user_guide/). We also have [a guide for administrators](./CONFIGURATION.md) and for [hackers/contributors](./HACKING.md). diff --git a/docs/docs/stickers.md b/docs/docs/stickers.md index ac4a1eca..3377dfaa 100644 --- a/docs/docs/stickers.md +++ b/docs/docs/stickers.md @@ -1,13 +1,13 @@ # Adding stickers -Pleroma-fe supports stickers, which are essentially little images stored server-side +Akkoma-FE supports stickers, which are essentially little images stored server-side which can be selected by a user to automatically attach them to a post. There's no explicit setting for these, they just rely on the existence of certain files. ## Initialising the sticker config file -You're probably serving pleroma-fe from your instance's `instance/static/` directory - +You're probably serving Akkoma-FE from your instance's `instance/static/` directory - this directy can also override files served at a given path. The first thing we need to do is set up our `stickers.json` file. At `instance/static/static/stickers.json`, @@ -50,4 +50,4 @@ The `tabIcon` will appear on the sticker picker itself as a representative of th You can add as many stickers as you like. They should all be in the same directory as your `pack.json`. -Now you should find that there's a sticky note icon on the emoji picker on pleroma-fe that allows you to attach stickers. +Now you should find that there's a sticky note icon on the emoji picker on Akkoma-FE that allows you to attach stickers. diff --git a/docs/docs/user_guide/index.md b/docs/docs/user_guide/index.md index ce4f69c2..2342ef92 100644 --- a/docs/docs/user_guide/index.md +++ b/docs/docs/user_guide/index.md @@ -8,13 +8,13 @@ > > --Catbag -Pleroma-FE is the default user-facing frontend for Pleroma. If your instance uses Pleroma-FE, you can access it by going to your instance (e.g. ). After logging in you will have two columns in front of you. Here we're going to keep it to the default behaviour, but some instances swap the left and right columns. If you're on such an instance what we refer to as the left column will be on your right and vice versa. +Akkoma-FE is the default user-facing frontend for Pleroma. If your instance uses Akkoma-FE, you can access it by going to your instance (e.g. ). After logging in you will have two columns in front of you. Here we're going to keep it to the default behaviour, but some instances swap the left and right columns. If you're on such an instance what we refer to as the left column will be on your right and vice versa. ### Left column - first block: This section is dedicated to [posting](posting_reading_basic_functions.md) - second block: Here you can switch between the different views for the right column. -- Optional third block: This is the Instance panel that can be activated, but is deactivated by default. It's fully customisable by instance admins and by default has links to the Pleroma-FE and Mastodon-FE. +- Optional third block: This is the Instance panel that can be activated, but is deactivated by default. It's fully customisable by instance admins and by default has links to the Akkoma-FE and Mastodon-FE. - fourth block: This is the Notifications block, here you will get notified whenever somebody mentions you, follows you, repeats or favorites one of your statuses ### Right column diff --git a/docs/docs/user_guide/posting_reading_basic_functions.md b/docs/docs/user_guide/posting_reading_basic_functions.md index 1a4a12d5..44f15673 100644 --- a/docs/docs/user_guide/posting_reading_basic_functions.md +++ b/docs/docs/user_guide/posting_reading_basic_functions.md @@ -15,13 +15,13 @@ Posts will contain the text you are posting, but some content will be modified: Let's clear up some basic stuff. When you post something it's called a **post** or it could be called a **status** or even a **toot** or a **prööt** depending on whom you ask. Post has body/content but it also has some other stuff in it - from attachments, visibility scope, subject line... **Emoji** are small images embedded in text, there are two major types of emoji: [unicode emoji](https://en.wikipedia.org/wiki/Emoji) and custom emoji. While unicode emoji are universal and standardized, they can appear differently depending on where you are using them or may not appear at all on older systems. Custom emoji are a more *fun* kind - instance administrator can define many images as *custom emoji* for their users. This works very simple - custom emoji is defined by its *shortcode* and an image, so that any shortcode enclosed in colons get replaced with image if such shortcode exist. -Let's say there's a `:pleroma:` emoji defined on an instance. That means -> First time using :pleroma: pleroma! +Let's say there's a `:akkoma:` emoji defined on an instance. That means +> First time using :akkoma: akkoma! -will become -> First time using ![pleroma](../assets/example_emoji.png) pleroma! +will become +> First time using ![akkoma](../assets/example_emoji.png) akkoma! -Note that you can only use emoji defined on your instance, you cannot "copy" someone else's emoji, and will have to ask your administrator to copy emoji from other instance to yours. +Note that you can only use emoji defined on your instance, you cannot "copy" someone else's emoji, and will have to ask your administrator to copy emoji from other instance to yours. Lastly, there's two convenience options for emoji: an emoji picker (smiley face to the right of "submit" button) and autocomplete suggestions - when you start typing :shortcode: it will automatically try to suggest you emoji and complete the shortcode for you if you select one. If emoji doesn't show up in suggestions nor in emoji picker it means there's no such emoji on your instance, if shortcode doesn't match any defined emoji it will appear as text. **Attachments** are fairly simple - you can attach any file to a post as long as the file is within maximum size limits. If you're uploading explicit material you can mark all of your attachments as sensitive (or add the `#nsfw` tag) - it will hide the images and videos behind a warning so that it won't be displayed instantly. @@ -42,7 +42,7 @@ A few things to consider about the security and usage of these scopes: - Changing scopes during a thread or adding people to a direct message will not retroactively make them see the whole conversation. If you add someone to a direct message conversation, they will not see the post that happened before they were mentioned. * **Reply-to** if you are replying to someone, your post will also contain a note that your post is referring to the post you're replying to. Person you're replying to will receive a notification *even* if you remove them from mentioned people. You won't receive notifications when replying to your own posts, but it's useful to reply to your own posts to provide people some context if it's a follow-up to a previous post. There's a small "Reply to ..." label under post author's name which you can hover on to see what post it's referring to. -Sometimes you may encounter posts that seem different than what they are supposed to. For example, you might see a direct message without any mentions in the text. This can happen because internally, the Fediverse has a different addressing mechanism similar to email, with `to` and `cc` fields. While these are not directly accessible in PleromaFE, other software in the Fediverse might generate those posts. Do not worry in these cases, these are normal and not a bug. +Sometimes you may encounter posts that seem different than what they are supposed to. For example, you might see a direct message without any mentions in the text. This can happen because internally, the Fediverse has a different addressing mechanism similar to email, with `to` and `cc` fields. While these are not directly accessible in Akkoma-FE, other software in the Fediverse might generate those posts. Do not worry in these cases, these are normal and not a bug. ## Rich text @@ -51,7 +51,7 @@ By default new posts you make are plaintext, meaning you can't make text **bold* Here is a small example of some text in markdown. ``` -This is an example of markdown text using **bold** and *cursive* text. +This is an example of markdown text using **bold** and *cursive* text. To get a newline we add two spaces at the end of the previous line. Let's also add a list @@ -67,7 +67,7 @@ If you set the input-method to Markdown, and post this, it will look something l ## Misskey markdown -The akkoma version of pleroma-fe includes support for writing and rendering +Akkoma-FE includes support for writing and rendering misskey markdown (MFM). To write this you will need to select "MFM" from the content type dropdown (if supported), and then you can format text [in MFM](https://akkoma.dev/sfr/marked-mfm/src/branch/master/docs/syntax.md). diff --git a/docs/docs/user_guide/settings.md b/docs/docs/user_guide/settings.md index ef9306c5..cf6bd8fa 100644 --- a/docs/docs/user_guide/settings.md +++ b/docs/docs/user_guide/settings.md @@ -83,7 +83,7 @@ Here you can change your password, revoke access tokens, configure 2-factor auth ## Theme -Here you can change the look and feel of Pleroma-FE. You can choose from several instance-provided presets and you can load one from file and save current theme to file. Before you apply new theme you can see what it will look like approximately in preview section. +Here you can change the look and feel of Akkoma-FE. You can choose from several instance-provided presets and you can load one from file and save current theme to file. Before you apply new theme you can see what it will look like approximately in preview section. The themes engine was made to be easy to use while giving an option for powerful in-depth customization - you can just tweak colors on "Common" tab and leave everything else as is. diff --git a/docs/docs/user_guide/users_follow_mute_block.md b/docs/docs/user_guide/users_follow_mute_block.md index 530b98a4..168b0073 100644 --- a/docs/docs/user_guide/users_follow_mute_block.md +++ b/docs/docs/user_guide/users_follow_mute_block.md @@ -4,7 +4,7 @@ When you see someone, you can click on their user picture to view their profile, **Following** is self-explanatory, it adds them to your Home Timeline, lists you as a follower and gives you access to follower-only posts if they have any. -**Muting** collapses posts and notifications made by them, giving you an option to see the post if you're curious. Clients other than PleromaFE may completely remove their posts. +**Muting** collapses posts and notifications made by them, giving you an option to see the post if you're curious. Clients other than Akkoma-FE may completely remove their posts. **Blocking** a user removes them from your timeline and notifications and prevents them from following you (automatically unfollows them from you). diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 73fca986..426ddae1 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,11 +1,11 @@ -site_name: Pleroma-FE Documentation +site_name: Akkoma-FE Documentation theme: - favicon: 'images/pleroma_logo_vector_bg_32.png' + favicon: 'images/akkoma_logo_vector_bg_32.png' name: 'material' custom_dir: 'theme' # Disable google fonts font: false - logo: 'images/pleroma_logo_vector_nobg.svg' + logo: 'images/akkoma_logo_vector_nobg.svg' features: - tabs palette: @@ -14,8 +14,8 @@ theme: extra_css: - css/extra.css -repo_name: 'AkkomaGang/pleroma-fe' -repo_url: 'https://akkoma.dev/AkkomaGang/pleroma-fe' +repo_name: 'AkkomaGang/akkoma-fe' +repo_url: 'https://akkoma.dev/AkkomaGang/akkoma-fe' extra: repo_icon: gitea diff --git a/docs/theme/partials/source.html b/docs/theme/partials/source.html index 3ed0fff2..3b10223b 100644 --- a/docs/theme/partials/source.html +++ b/docs/theme/partials/source.html @@ -38,11 +38,11 @@ {% endif %} {% if page and page.url.startswith('backend') %} - {% set repo_url = "https://git.pleroma.social/pleroma/pleroma" %} - {% set repo_name = "pleroma/pleroma" %} + {% set repo_url = "https://akkoma.dev/AkkomaGang/akkoma" %} + {% set repo_name = "AkkomaGang/akkoma" %} {% elif page and page.url.startswith('frontend') %} - {% set repo_url = "https://git.pleroma.social/pleroma/pleroma-fe" %} - {% set repo_name = "pleroma/pleroma-fe" %} + {% set repo_url = "https://akkoma.dev/AkkomaGang/akkoma-fe" %} + {% set repo_name = "AkkomaGang/akkoma-fe" %} {% else %} {% set repo_url = config.repo_url %} {% set repo_name = config.repo_name %}