Skip to content

docs: merge md files with cc-book#2178

Merged
fewerner merged 13 commits into
mainfrom
felix/merge-docs-ccbook
May 28, 2026
Merged

docs: merge md files with cc-book#2178
fewerner merged 13 commits into
mainfrom
felix/merge-docs-ccbook

Conversation

@fewerner
Copy link
Copy Markdown
Contributor

What's new in this PR

This PR moves all docs files which are not Readme or docs entry point to the cc--book.


PR Submission Checklist for internal contributors
  • The PR Title
    • conforms to the style of semantic commits messages¹ supported in Wire's Github Workflow²
    • contains a reference JIRA issue number like SQPIT-764
    • answers the question: If merged, this PR will: ... ³
  1. https://sparkbox.com/foundry/semantic_commit_messages
  2. https://github.com/wireapp/.github#usage
  3. E.g. feat(conversation-list): Sort conversations by most emojis in the title #SQPIT-764.

@fewerner fewerner marked this pull request as ready for review May 27, 2026 13:45
@fewerner fewerner requested a review from a team May 27, 2026 13:45
@istankovic
Copy link
Copy Markdown
Member

@fewerner why are we pulling in mermaid?

Copy link
Copy Markdown
Member

@istankovic istankovic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should clarify why we need to pull in minified mermaid.

@fewerner fewerner force-pushed the felix/merge-docs-ccbook branch 2 times, most recently from b930b9d to 1d04f14 Compare May 28, 2026 08:14
Comment thread .github/workflows/check-cc-book.yml Outdated
Comment thread .github/workflows/docs-cc-book.yml Outdated
@istankovic
Copy link
Copy Markdown
Member

It would be nice if commit message of bc58a6a31753ca6335bf81ad4bc3a886e472fe47 said what diagram is being added.

Comment thread cc-book/src/development/ARCHITECTURE.md Outdated
Copy link
Copy Markdown
Member

@istankovic istankovic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, without vendored mermaid this looks much better!

@fewerner fewerner force-pushed the felix/merge-docs-ccbook branch 4 times, most recently from c782d02 to 825bd84 Compare May 28, 2026 08:49
fewerner added 13 commits May 28, 2026 11:01
This should have been removed when we switched from antora to mdbook
These files should not be part of the repo but installed once locally.
These files will be added when installing the mdbook dependencies to
cc-book.
We reduce code duplication with a composite action.

We also replace the curl commands here and instead use
taiki-e/install-action which will call `cargo binstall`.

We rely on this action across the whole project. There is no reason to
do something else here.
We delete quite a lot of incorrect or redundant docs here.

The naming conventions section can be dropped, as we don't want to
maintain a style guide here and instead enforce our style through CI.

I also delete some architecture sections that focused on mls
implementation details rather than architecture. These are likely to
change and don't add much value here.
With urbn these types translate to bigint.
There is no reason to include the readme here.
`KEYSTORE_IMPLEMENTATION.md` conceptionally described the implementation
but is no replacement for a module doc string.
@fewerner fewerner force-pushed the felix/merge-docs-ccbook branch from 825bd84 to 5daf73b Compare May 28, 2026 09:01
@fewerner fewerner merged commit 5daf73b into main May 28, 2026
14 checks passed
@fewerner fewerner deleted the felix/merge-docs-ccbook branch May 28, 2026 09:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants