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

docs: crate docs for lib.rs #257

Merged
merged 2 commits into from
Mar 22, 2023

Conversation

josecelano
Copy link
Member

Entrypoint for the crate documentation, the lib.rs file.

@josecelano josecelano added the Documentation Improves Instructions, Guides, and Notices label Mar 21, 2023
@josecelano josecelano linked an issue Mar 21, 2023 that may be closed by this pull request
Copy link
Contributor

Choose a reason for hiding this comment

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

Is it possible to include this file as a SVG file?

Copy link
Member Author

@josecelano josecelano Mar 21, 2023

Choose a reason for hiding this comment

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

Hi @da2ce7, I did it with miro, and I do not see any option to export to SVG. I think they only support PDFs. I wanted an image format because I'm embedding the image in the crate docs here.

I will try to find an alternative to miro. I would like to do something more formal like https://c4model.com/ but maybe after reviewing the whole app architecture.

@josecelano josecelano merged commit 1333cc0 into torrust:develop Mar 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improves Instructions, Guides, and Notices
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

crate docs: for lib.rs mod
2 participants