Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft: migrate Architecture docs #4632

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

f18m
Copy link
Contributor

@f18m f18m commented Nov 27, 2023

Problem: ZMQ internal architecture is documented only (AFAIK) in the old website http://zeromq.wikidot.com/whitepapers:architecture

Solution: bring libzmq-specific architecture docs into libzmq github repository

@f18m
Copy link
Contributor Author

f18m commented Nov 27, 2023

Hi @bluca ,
let me know what you think about this PR (not completed yet).
I think the page http://zeromq.wikidot.com/whitepapers:architecture was really useful to me when I first started debugging libzmq internals.

Given that the old wiki is sort of abandoned, I think this valuable information should find a new home. A possibility is, as I did here, to integrate the architecture definition in official docs.
Other possibilities would be:

  • enable the GitHub wiki feature and re-create the architecture page there.
  • add the architecture page as a MarkDown/AsciiDoc page under github but exclude that from the manpages and from the HTML docs published by readthedocs.io (rationale: this is internal docs for advanced users only)

@bluca
Copy link
Member

bluca commented Nov 27, 2023

This is fine by me, just one thing, can you use svg for the images? I think it works better in git for storage purposes

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.

2 participants