WIP: docs: Merge README and introduction.mdx page and clean them up #2251

Closed
stratself wants to merge 14 commits from stratself/continuwuity:stratself/docs-merge-readmes into main
Member

This pull request symlinks introduction.mdx from README.md, as they're nearly identical pages. It also removed the "what are we working on" section from the readme as discussed the other day, and contains some wording fixes as well.

introduction.mdx.old contains the old page, and will be removed before merge once other changes are approved.

Closes #1569

Pull request checklist:

  • This pull request targets the main branch, and the branch is named something other than
    main.
  • I have written an appropriate pull request title and my description is clear.
  • I understand I am responsible for the contents of this pull request.
  • I have followed the contributing guidelines:
This pull request symlinks `introduction.mdx` from `README.md`, as they're nearly identical pages. It also removed the "what are we working on" section from the readme as discussed the other day, and contains some wording fixes as well. `introduction.mdx.old` contains the old page, and will be removed before merge once other changes are approved. Closes #1569 <!-- Example: This pull request allows us to warp through time and space ten times faster than before by double-inverting the warp drive with hyperheated jump fluid, both making the drive faster and more efficient. This resolves the common issue where we have to wait more than 10 milliseconds to engage, use, and disengage the warp drive when travelling between galaxies. --> <!-- Closes: #... --> <!-- Fixes: #... --> <!-- Uncomment the above line(s) if your pull request fixes an issue or closes another pull request by superseding it. Replace `#...` with the issue/pr number, such as `#123`. --> **Pull request checklist:** <!-- You need to complete these before your PR can be considered. If you aren't sure about some, feel free to ask for clarification in #dev:continuwuity.org. --> - [x] This pull request targets the `main` branch, and the branch is named something other than `main`. - [x] I have written an appropriate pull request title and my description is clear. - [x] I understand I am responsible for the contents of this pull request. - I have followed the [contributing guidelines][c1]: - [x] My contribution follows the [code style][c2], if applicable. - [x] I ran [pre-commit checks][c1pc] before opening/drafting this pull request. - [x] I have [tested my contribution][c1t] (or proof-read it for documentation-only changes) myself, if applicable. This includes ensuring code compiles. - [x] My commit messages follow the [commit message format][c1cm] and are descriptive. <!-- Notes on these requirements: - While not required, we encourage you to sign your commits with GPG or SSH to attest the authenticity of your changes. - While we allow LLM-assisted contributions, we do not appreciate contributions that are low quality, which is typical of machine-generated contributions that have not had a lot of love and care from a human. Please do not open a PR if all you have done is asked ChatGPT to tidy up the codebase with a +-100,000 diff. - In the case of code style violations, reviewers may leave review comments/change requests indicating what the ideal change would look like. For example, a reviewer may suggest you lower a log level, or use `match` instead of `if/else` etc. - In the case of code style violations, pre-commit check failures, minor things like typos/spelling errors, and in some cases commit format violations, reviewers may modify your branch directly, typically by making changes and adding a commit. Particularly in the latter case, a reviewer may rebase your commits to squash "spammy" ones (like "fix", "fix", "actually fix"), and reword commit messages that don't satisfy the format. - Pull requests MUST pass the `Checks` CI workflows to be capable of being merged. This can only be bypassed in exceptional circumstances. If your CI flakes, let us know in matrix:r/dev:continuwuity.org. - Pull requests have to be based on the latest `main` commit before being merged. If the main branch changes while you're making your changes, you should make sure you rebase on main before opening a PR. Your branch will be rebased on main before it is merged if it has fallen behind. - We typically only do fast-forward merges, so your entire commit log will be included. Once in main, it's difficult to get out cleanly, so put on your best dress, smile for the cameras! --> [c1]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md [c2]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/docs/development/code_style.mdx [c1pc]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#pre-commit-checks [c1t]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#running-tests-locally [c1cm]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#commit-messages
@ -94,2 +101,4 @@
See our [Contributing page](CONTRIBUTING.md) for more details.
### Development flow
Author
Member

Development flow and pulling policy could go into CONTRIBUTING.md instead. Requesting for approval to do so, maybe in a future PR.

Development flow and pulling policy could go into `CONTRIBUTING.md` instead. Requesting for approval to do so, maybe in a future PR.
stratself force-pushed stratself/docs-merge-readmes from 20745e6902
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Auto Labeler / Apply labels based on changed files (pull_request_target) Successful in 3s
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 8s
Checks / Prek / Check changed files (pull_request) Successful in 7s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m28s
to a22641330e
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 8s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m14s
Update flake hashes / update-flake-hashes (pull_request) Successful in 1m26s
2026-09-14 11:29:08 +00:00
Compare
stratself force-pushed stratself/docs-merge-readmes from a22641330e
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 8s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m14s
Update flake hashes / update-flake-hashes (pull_request) Successful in 1m26s
to 6015c639b5
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 8s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m11s
Update flake hashes / update-flake-hashes (pull_request) Successful in 1m26s
2026-09-15 07:13:26 +00:00
Compare
stratself force-pushed stratself/docs-merge-readmes from 6015c639b5
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 8s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m11s
Update flake hashes / update-flake-hashes (pull_request) Successful in 1m26s
to 7fbb062edb
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 8s
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 18s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m58s
Update flake hashes / update-flake-hashes (pull_request) Successful in 1m46s
2026-09-16 18:10:03 +00:00
Compare
stratself force-pushed stratself/docs-merge-readmes from 7fbb062edb
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 8s
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 18s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m58s
Update flake hashes / update-flake-hashes (pull_request) Successful in 1m46s
to 00834a1afd
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 5s
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Update flake hashes / update-flake-hashes (pull_request) Successful in 1m27s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 2m8s
2026-09-19 06:43:55 +00:00
Compare
stratself changed title from docs: Merge README and introduction.mdx page to docs: Merge README and introduction.mdx page and clean them up 2026-09-19 06:47:48 +00:00
docs: Rename meta for introduction page to "Introduction"
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Checks / Prek / Check changed files (pull_request) Successful in 7s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m31s
c11931eb20
docs(README): Add Open Collective donation button
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m28s
a75c98069e
docs(style): Disable zooming on badges + better buttons
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Checks / Prek / Check changed files (pull_request) Successful in 7s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m28s
b1b41f833e
* Introduce the `.no-zoom` div class to disable zooming specific imgs
* Forge-related buttons are stylized with primary color
* Open Collective donation button now has bigger vertical margins
stratself force-pushed stratself/docs-merge-readmes from 6b6413d5bf
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Has been cancelled
to 10bda5da1b
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 10s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m32s
2026-09-20 07:55:55 +00:00
Compare
Author
Member

a75c98069e will partially solve #2260

a75c98069e will partially solve #2260
stratself force-pushed stratself/docs-merge-readmes from 152b6036a1
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m31s
to adb6c9c199
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 6s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m11s
2026-09-20 08:10:01 +00:00
Compare
stratself force-pushed stratself/docs-merge-readmes from adb6c9c199
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Prek / Check changed files (pull_request) Successful in 6s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 6s
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m11s
to f475c8e4cb
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Checks / Prek / Check changed files (pull_request) Successful in 7s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m28s
2026-09-20 08:21:32 +00:00
Compare
stratself changed title from docs: Merge README and introduction.mdx page and clean them up to WIP: docs: Merge README and introduction.mdx page and clean them up 2026-09-21 17:55:51 +00:00
Author
Member

From #dev room

i just realized c10y has a very good intro page already, but it's hidden in the main index
https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/docs/index.mdx#L49-L61
maybe i should beautify it and use it for the intro page, instead of merging the readmes like in !2251?

Feel free to use it!

That means I'll probably close this. Looks better for the site as well

[From #dev room](https://matrix.to/#/!c10y-8Hm3mAW99j9KEKoWPQH2M_FxGwG-EVHK06iLKg/%24utLVzq8RPpkrydWJSAaP3cWKzFsU4bTL__UF_iiLSm0?via=muoi.me&via=continuwuity.org&via=matrix.org) > i just realized c10y has a very good intro page already, but it's hidden in the main index >https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/docs/index.mdx#L49-L61 > maybe i should beautify it and use it for the intro page, instead of merging the readmes like in !2251? > > Feel free to use it! That means I'll probably close this. Looks better for the site as well
Author
Member

Closing in favor of #2278 and #2279

Closing in favor of #2278 and #2279
stratself closed this pull request 2026-09-23 10:05:01 +00:00
All checks were successful
Documentation / Build and Deploy Documentation (pull_request) Has been skipped
Checks / Changelog / Check changelog is added (pull_request_target) Successful in 7s
Required
Details
Checks / Prek / Check changed files (pull_request) Successful in 7s
Required
Details
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been skipped
Required
Details
Checks / Prek / Pre-commit & Formatting (pull_request) Successful in 1m28s
Required
Details

Pull request closed

Sign in to join this conversation.
No reviewers
No milestone
No assignees
1 participant
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!2251
No description provided.