• This directory contains only files that have been modified within the past year (since February 19, 2025). All older files have been moved to the wire-docs repository.

• These files are included in the wire-docs repository as a submodule and are pulled during the build process. They are essential for constructing the complete Wire documentation site. Any changes to these files should be made here, while updates to the older files (not present here anymore) should be committed directly to the wire-docs repository.

• The Markdown (.md) pages in this directory should be self-contained, including any static images or diagrams. However, please note that links within these documents may not function correctly, as they are relative to the wireapp/wire-docs/src directory. To ensure that document links work as intended, collaborate with the wire-docs repository to identify their correct locations.

• build workflow:

  • This workflow automates documentation validation between the wire-server and wire-docs repositories.

  • When a PR is made to wire-server's develop branch, GitHub Actions clones wire-docs and temporarily modifies its .gitmodules to point to the PR branch instead of develop. It then runs a build process to validate that the documentation changes work correctly with wire-docs symlink structure.

  • If validation passes, the workflow creates a second PR to wire-docs that updates the submodule reference to point to the specific commit ID from the original PR.

  • This dual-PR approach ensures that documentation changes are fully tested before being merged and maintains version stability by pinpointing exact commits rather than following branches.

• wire-docs: Main documentation repository
• wire-server/docs: Documentation related to the code in the wire-server repository

For content in wire-server/docs:

1. Make changes directly in the wire-server/docs directory
2. Create a PR against the wire-server:develop branch
3. Once merged, these changes will be picked up by wire-docs through submodule updates

For content only in wire-docs:

1. Make changes directly in wire-docs/src
2. Create a PR against wire-docs:main branch

When a page needs to be moved because it's related to code changes:

1. Add the page to wire-server/docs and merge it to the develop branch
2. In wire-docs:
   • Update the wire-server submodule (to the latest commit) and commit that change
   • Delete the original page from wire-docs/src
   • Create a relative symbolic link to the file in the wire-server module:

     cd src/developer/reference/
     rm example-file.svg
     ln -s ../../../wire-server/docs/src/developer/reference/example-file.svg example-file.svg
     

3. Commit new linked files before testing with make run
4. Test with make run before creating a PR

1. Create the file in wire-server/docs
2. Merge it into wire-server:develop
3. To make it discoverable on docs.wire.com:
   • Update the navigation structure in mkdocs.yml or update the directory's README.md to include references to the new file, or add references to the new file from relevant existing pages
   • Update the wire-server submodule reference in wire-docs (if not done automatically) and commit the change
   • Add references to the new file from relevant existing pages
   • Test with make run and create a PR to wire-docs:main

1. Add the page to wire-docs/src in the appropriate location
2. Update the navigation structure in mkdocs.yml or update the directory's README.md to include references to the new file, or add references to the new file from relevant existing pages
3. Test with make run and create a PR to wire-docs:main

1. Identify all references to the file in wire-server/docs and wire-docs
2. Remove all references and links from navigation (mkdocs.yml) and other pages
3. Delete the file from its location
4. Submit a PR to wire-server:develop

1. Identify all references to the file in wire-docs and wire-server/docs
2. Remove all references and links from navigation (mkdocs.yml) and other pages
3. Delete the file from its location
4. Commit local deleted files before testing with make run
5. Submit a PR to wire-docs:main

All changes to documentation go live when the CI Build workflow on wire-docs runs. Currently, submodule updates from wire-server to wire-docs are performed manually, but there are plans to automate this with a pipeline.