New Readme #752

Manually merged
Jade merged 0 commits from new-readme into main 2025-04-15 09:20:35 +00:00
Owner

First iteration of the new README.

Missing compared to the original:

  • Contact
  • Mirrors
  • A way for users to try it out (aka a public server)
  • 'Differences' section

Not all of these are things we can or want to add right now, so I think the current state is good.

First iteration of the new README. Missing compared to the original: - Contact - Mirrors - A way for users to try it out (aka a public server) - 'Differences' section Not all of these are things we can or want to add right now, so I think the current state is good.
Jade added the
Documentation
label 2025-04-14 21:35:58 +00:00
Jade added 1 commit 2025-04-14 21:35:58 +00:00
docs: New readme
Some checks failed
CI and Artifacts / Test (pull_request) Failing after 0s
CI and Artifacts / Build (pull_request) Failing after -1s
CI and Artifacts / variables (pull_request) Failing after -2s
Documentation and GitHub Pages / Documentation and GitHub Pages (pull_request) Failing after -1s
CI and Artifacts / Docker publish (pull_request) Has been skipped
f2e42dfad3
requested review from nex 2025-04-14 21:37:16 +00:00
Owner

LGTM! 🙂

LGTM! 🙂
nex requested changes 2025-04-14 21:44:42 +00:00
Dismissed
nex left a comment
Owner

Looks good, just a few things I think might want a second look

Looks good, just a few things I think might want a second look
README.md Outdated
@ -2,2 +1,4 @@
# continuwuity
<!--
[![conduwuit main room](https://img.shields.io/matrix/conduwuit%3Apuppygock.gay?server_fqdn=matrix.transfem.dev&style=flat&logo=matrix&logoColor=%23f5b3ff&label=%23conduwuit%3Apuppygock.gay&color=%23f652ff)](https://matrix.to/#/#conduwuit:puppygock.gay) [![conduwuit space](https://img.shields.io/matrix/conduwuit-space%3Apuppygock.gay?server_fqdn=matrix.transfem.dev&style=flat&logo=matrix&logoColor=%23f5b3ff&label=%23conduwuit-space%3Apuppygock.gay&color=%23f652ff)](https://matrix.to/#/#conduwuit-space:puppygock.gay)
Owner

We should probably remove links to upstream conduwuit altogether - project is gone and most likely not coming back.

We should probably remove links to upstream conduwuit altogether - project is gone and most likely not coming back.
Author
Owner

Mainly kept them there in the event we wanted to put up our own badges. I guess that kinda stuff is what Git history is for

Mainly kept them there in the event we wanted to put up our own badges. I guess that kinda stuff is what Git history is for
Jade marked this conversation as resolved
README.md Outdated
@ -15,3 +16,3 @@
<!-- ANCHOR: catchphrase -->
### a very cool [Matrix](https://matrix.org/) chat homeserver written in Rust
## A community-driven [Matrix](https://matrix.org/) homeserver in Rust
Owner

Are we not cool anymore? :(

Are we not cool anymore? :(
Author
Owner

Dividing shades between five people is unfortunately not practical :(

Dividing shades between five people is unfortunately not practical :(
Owner

Hah, you make a good point 🧌

Hah, you make a good point 🧌
nex marked this conversation as resolved
README.md Outdated
@ -58,1 +73,4 @@
- Automated testing
- [Admin API](https://forgejo.ellis.link/continuwuity/continuwuity/issues/748)
- [Policy-list controlled moderation](https://forgejo.ellis.link/continuwuity/continuwuity/issues/750)
Owner

A link to /issues may be good here, as mentioned on the original doc having an exclusive list with no "and more" can lead people skimming over to believe we've got a narrow goal

A link to /issues may be good here, as mentioned on the original doc having an exclusive list with no "and more" can lead people skimming over to believe we've got a narrow goal
Jade marked this conversation as resolved
README.md Outdated
@ -106,3 +85,1 @@
There is an interest in developing a built-in seamless user data migration
method into conduwuit, however there is no concrete ETA or timeline for this.
Although you can't migrate your data from other homeservers, it is perfectly acceptable to set up continuwuity on the same domain as a previous homeserver.
Owner

we definitely need to have a "migration guide", too many people forget to leave rooms when ditching databases

we definitely need to have a "migration guide", too many people forget to leave rooms when ditching databases
Author
Owner

I've replaced this with a todo.

I've replaced this with a todo.
Jade marked this conversation as resolved
Aranjedeath reviewed 2025-04-14 21:48:21 +00:00
README.md Outdated
@ -27,0 +37,4 @@
We are a group of Matrix enthusiasts, developers and system administrators who have used conduwuit and believe in its potential. Our team includes both previous
contributors to the original project and new developers who want to help maintain and improve this important piece of Matrix infrastructure.
We operate as an open community project, welcoming contributions from anyone interested in improving continuwuity.
Owner

project, and we welcome

project, and we welcome
Author
Owner

Is the new phrasing good?

Is the new phrasing good?
Jade marked this conversation as resolved
Aranjedeath reviewed 2025-04-14 21:48:41 +00:00
README.md Outdated
@ -57,1 +68,3 @@
beta status not entirely applicable to us anymore.
- [Replacing old conduwuit links with working continuwuity links](https://forgejo.ellis.link/continuwuity/continuwuity/issues/742)
- [Getting CI and docs deployment working on the new Forgejo project](https://forgejo.ellis.link/continuwuity/continuwuity/issues/740)
- [Packaging & availibility in more places](https://forgejo.ellis.link/continuwuity/continuwuity/issues/747)
Owner

availability

availability
Jade marked this conversation as resolved
Aranjedeath reviewed 2025-04-14 21:48:51 +00:00
README.md Outdated
@ -58,0 +69,4 @@
- [Getting CI and docs deployment working on the new Forgejo project](https://forgejo.ellis.link/continuwuity/continuwuity/issues/740)
- [Packaging & availibility in more places](https://forgejo.ellis.link/continuwuity/continuwuity/issues/747)
- [Appservices bugs & features](https://forgejo.ellis.link/continuwuity/continuwuity/issues?q=&type=all&state=open&labels=178&milestone=0&assignee=0&poster=0)
- [Improving compatiblitity and spec compliance](https://forgejo.ellis.link/continuwuity/continuwuity/issues?labels=119)
Owner

compatibility

compatibility
Jade marked this conversation as resolved
Jade added 1 commit 2025-04-14 21:55:11 +00:00
docs: typos
Some checks failed
CI and Artifacts / Test (pull_request) Failing after -1s
CI and Artifacts / Build (pull_request) Failing after -1s
CI and Artifacts / variables (pull_request) Failing after -2s
Documentation and GitHub Pages / Documentation and GitHub Pages (pull_request) Failing after -1s
CI and Artifacts / Docker publish (pull_request) Has been skipped
19cd66179b
Jade added 1 commit 2025-04-14 21:56:55 +00:00
docs: Fix incorrect links
Some checks failed
CI and Artifacts / Test (pull_request) Failing after -1s
CI and Artifacts / Build (pull_request) Failing after -1s
CI and Artifacts / variables (pull_request) Failing after -2s
Documentation and GitHub Pages / Documentation and GitHub Pages (pull_request) Failing after -1s
CI and Artifacts / Docker publish (pull_request) Has been skipped
4ad669e65c
Jade added 1 commit 2025-04-14 21:58:34 +00:00
docs: Remove hidden conduwuit badges
Some checks failed
CI and Artifacts / Test (pull_request) Failing after -1s
CI and Artifacts / Build (pull_request) Failing after -1s
CI and Artifacts / variables (pull_request) Failing after -2s
Documentation and GitHub Pages / Documentation and GitHub Pages (pull_request) Failing after 0s
CI and Artifacts / Docker publish (pull_request) Has been skipped
f25c85cbd7
Jade added 1 commit 2025-04-14 22:01:25 +00:00
docs: Phrasing
Some checks failed
CI and Artifacts / Test (pull_request) Failing after -1s
CI and Artifacts / Build (pull_request) Failing after -1s
CI and Artifacts / variables (pull_request) Failing after -2s
Documentation and GitHub Pages / Documentation and GitHub Pages (pull_request) Failing after -1s
CI and Artifacts / Docker publish (pull_request) Has been skipped
0669201965
requested reviews from nex, Aranjedeath, tcpipuk 2025-04-14 22:03:35 +00:00
Jade added 1 commit 2025-04-14 22:06:46 +00:00
docs: Mention future migration guide
Some checks failed
CI and Artifacts / Test (pull_request) Failing after -1s
CI and Artifacts / Build (pull_request) Failing after 1s
CI and Artifacts / variables (pull_request) Failing after -2s
Documentation and GitHub Pages / Documentation and GitHub Pages (pull_request) Failing after -1s
CI and Artifacts / Docker publish (pull_request) Has been skipped
76d195fa64
nex approved these changes 2025-04-14 22:25:43 +00:00
nex left a comment
Owner

Skimmed over the last half but everything looks fine to me now 👍

Skimmed over the last half but everything looks fine to me now 👍
nex added the
Meta
label 2025-04-14 22:29:55 +00:00
Jade force-pushed new-readme from 76d195fa64 to 4f9e9174e2 2025-04-15 09:18:35 +00:00 Compare
Jade manually merged commit 4f9e9174e2 into main 2025-04-15 09:20:35 +00:00
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
4 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: continuwuation/continuwuity#752
No description provided.