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

feat: Mdbook, use rustdoc_include and anchors #152

Closed
julio4 opened this issue Dec 13, 2023 · 2 comments
Closed

feat: Mdbook, use rustdoc_include and anchors #152

julio4 opened this issue Dec 13, 2023 · 2 comments

Comments

@julio4
Copy link
Member

julio4 commented Dec 13, 2023

Related to #70

We can replace include with rustdoc_include in the mdbook files.
This allows readers to expand the contract and view the tests directly in the book (without altering the current appearance).

Todo:

  • Move all tests into the same contract files
  • Adjust listing inclusions in book files
  • Insert contract/test anchors as necessary
  • Revise the Contribution guidelines to reflect these changes

An example will be provided soon...
@julio4 julio4 mentioned this issue Apr 12, 2024
Merged
This was referenced May 2, 2024
Merged
Merged
@0xibs
Copy link
Contributor

0xibs commented May 21, 2024

Can I hop on this? @julio4

@julio4 julio4 closed this as not planned Won't fix, can't repro, duplicate, stale May 21, 2024
@julio4
Copy link
Member Author

julio4 commented May 21, 2024

Can I hop on this? @julio4

Hello, we will be moving out of mdbook soon so it's not needed anymore

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@julio4 @0xibs