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.

Sign up for GitHub

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

Jump to bottom

Docs include README #429

Merged
merged 1 commit into from
Nov 13, 2022
Merged

Docs include README #429

merged 1 commit into from
Nov 13, 2022

Conversation

pinkforest
Copy link
Contributor

Fixes #426

@tarcieri will affect #428 for src/lib.rs changes

@pinkforest
Copy link
Contributor Author

I wonder if these are more of manifest thing now ? if not then need to host the html logo somewhere I guess 🤔

#![doc(html_logo_url = "https://doc.dalek.rs/assets/dalek-logo-clear.png")]
#![doc(html_root_url = "https://docs.rs/curve25519-dalek/4.0.0-pre.2")]

@pinkforest
Include README.md into the crate Documentation
62fe24e 
As proposed in #426 this commit changes to include README.md into
the crate documentation instead of maintaining a carbon copy in
the code.

This helps to keep the documentation in a single place without
duplicating the documentation in multiple places leading to less
errors and out of date documentation.
@rozbb
Copy link
Contributor

rozbb commented Nov 13, 2022

Yeah we gotta figure out where this will be hosted soon. Regardless, looks good. Thank you!

@rozbb rozbb merged commit e85e3c0 into dalek-cryptography:release/4.0 Nov 13, 2022
@pinkforest pinkforest deleted the docs/readme/de-dup branch November 13, 2022 06:04
@rozbb
Copy link
Contributor

rozbb commented Nov 13, 2022

Btw I'm gonna try soon to push some docs fixes I've had sitting around on my machine. They're out of date so I'll have to resolve some conflicts first.

@pinkforest
Copy link
Contributor Author

pinkforest commented Nov 13, 2022 •
edited
Loading

Could use github.io static pages ? e.g. under dalek-cryptography a new repo like "dalek-web" or "dalek-static-assets" ?

@rozbb
Copy link
Contributor

rozbb commented Nov 13, 2022

Yup, we might end up doing that. It'd be even nicer if we got docs.rs working, which #423 alleges will work

@pinkforest
Copy link
Contributor Author

I have a feeling it needs more docsrs related meta: #341 (comment)

Aso need to refactor the current #[cfg(rustdoc)] around to fit the cfg that is used for docsrs now.

Lmk when you've pushed your docs fixes so I can work on top of that

@pinkforest pinkforest mentioned this pull request Nov 13, 2022
Closed
@rozbb
Copy link
Contributor

rozbb commented Nov 13, 2022

Will do!

@pinkforest
Copy link
Contributor Author

btw #426 can be closed now 🎉

@rozbb rozbb mentioned this pull request Nov 13, 2022
Merged
@rozbb
Copy link
Contributor

rozbb commented Nov 14, 2022

Sorry for the delay. The docs-cleanup branch should have my (small) Markdown fixes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tarcieri tarcieri tarcieri approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@pinkforest @rozbb @tarcieri