Fix spelling errors

pull/1054/head
James Mills 1 month ago
parent 8bc5136bc4
commit 54dbbe6535
Signed by: prologic
GPG Key ID: AC4C014F1440EBD6
  1. 38
      docs/ReleaseNotes.md

@ -2,28 +2,24 @@
Hello Yarners! 🤗
It's again been a long while since our [Last Relase yarnd v0.14](https://git.mills.io/yarnsocial/yarn/releases/tag/0.14.0)
over ~6 months ago! 😳 Sorry about that! 🙏 I guess we got a bit busy with a few other things going on...
It's again been a long while since our [Last Release yarnd v0.14](https://git.mills.io/yarnsocial/yarn/releases/tag/0.14.0) over ~6 months ago! 😳 Sorry about that! 🙏 I guess we got a bit busy with a few other things going on...
First of all a big thanks to everybody who has given all of their time and effort to help Yarn.social become a better platform every day.
Without further ado, here are the hightlights for the 0.15 release!
Without further ado, here are the highlights for the 0.15 release!
## Highlights
- **Twtxt Search Engine** -- The much improved [Twtxt Search Engine](https://search.twtxt.net)
- **NEW** Sync API 🥳 (see below)
- Add Block Quote butotn to the Postbox.
- Add Block Quote button to the Postbox.
- Add official "Feed Types" (see below)
Its a bit of a small(ish) release with no that many "big" new features (sorry!)
mostly just bug fixes and little improvements. So if you're curious please see
the full Change Log below.
Its a bit of a small(ish) release with no that many "big" new features (sorry!) mostly just bug fixes and little improvements. So if you're curious please see the full Change Log below.
### Twtxt Search Engine
The **much improved** [Twtxt Search Engine](https://search.twtxt.net) is out
which improves the index greatly, performance and overall functionality and UX.
The **much improved** [Twtxt Search Engine](https://search.twtxt.net) is out which improves the index greatly, performance and overall functionality and UX.
Help pages have been improved and overall searches are "just better".
@ -31,37 +27,25 @@ Check it out!
### Sync API
For a [long time](https://search.twtxt.net/search?q=Sync+API&f=) we've talked
about the possibility of "syncing" a local feed with your feed on a Yarn.social
pod. This is now possible with a 3-way Sync API `/api/v1/sync` and a sub-command
of the `yarnc` command-line client. Usage is as simple as:
For a [long time](https://search.twtxt.net/search?q=Sync+API&f=) we've talked about the possibility of "syncing" a local feed with your feed on a Yarn.social pod. This is now possible with a 3-way Sync API `/api/v1/sync` and a sub command of the `yarnc` command-line client. Usage is as simple as:
```console
$ yarnc sync twtxt.txt
```
See `yarnc sync --help` and the [Sync API](https://dev.twtxt.net/doc/api.html#sync)
APi endpoint documentation for more deatils.
See `yarnc sync --help` and the [Sync API (https://dev.twtxt.net/doc/api.html#sync) API endpoint documentation for more details.
### Feed Types
In order to better improve the codebase and manageability of different feed
types such as autoamted feeds (bots) and RSS / Atom feeds, we have defined a
set of [Feed Types](https://pkg.go.dev/go.yarn.social/types#FeedType) namely:
In order to better improve the code and manageability of different feed types such as automated feeds (bots) and RSS / Atom feeds, we have defined a set of [Feed Types](https://pkg.go.dev/go.yarn.social/types#FeedType) namely:
- `rss` -- A Twtxt feed whose primary source comes from an RSS / Atom feed.
- `bot` -- A Twtxt feed which is fully automated by some script or automation.
These are the **only** feed types currently and we do not expect any more really.
The way this works is ti simply add `# type = rss|bot` to your feed if the feed
you are publishing is a non-human/non-user feed. Omitting the `type`
[Metadata](https://dev.twtxt.net/doc/metadataextension.html) is completely fine
and optional. The default for all feeds is a User / Human feed.
These are the **only** feed types currently and we do not expect any more really. The way this works is ti simply add `# type = rss|bot` to your feed if the feed you are publishing is a non-human/non-user feed. Omitting the `type` [Metadata](https://dev.twtxt.net/doc/metadataextension.html) is completely fine and optional. The default for all feeds is a User / Human feed.
This helps us categorize and filter out noisey feeds, autoamted feeds from views
like the "Discover" view on Yarn.social pods and serve as a way to "filter"
for these types of feed in the [Twtxt Search Engine](https://search.twtxt.net).
This helps us categorize and filter out noise feeds, automated feeds from views like the "Discover" view on Yarn.social pods and serve as a way to "filter" for these types of feed in the [Twtxt Search Engine](https://search.twtxt.net).
----
As per usual, please provide feedback to @prologic or reply to this Yarn 🤗
As per usual, please provide feedback to @prologic or reply to this Yarn 🤗
Loading…
Cancel
Save