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

Map code to docs, consider automating testing of code in docs #1636

Closed
Clay-Mysten opened this issue Apr 27, 2022 · 4 comments · Fixed by #2260 or #2259
Closed

Map code to docs, consider automating testing of code in docs #1636

Clay-Mysten opened this issue Apr 27, 2022 · 4 comments · Fixed by #2260 or #2259
Assignees
@huitseeker @awelc @bmwill @longbowlu @Clay-Mysten
Labels
Priority: High Very important task, not blocking but potentially delaying milestones or limiting our offering Type: Documentation Improvements or additions to documentation
Milestone
[G] Mainnet

Comments

@Clay-Mysten
Copy link
Contributor

Adam and I agreed it would be worthwhile to identify all of the code our docs reference so we may ensure updates to one are at least considered for the other. To this end, I have created this mapping:
https://app.golinks.io/code2docs

It identifies .move and .toml files referenced in (and typically linked from) the docs. The goal is to insert a code comment near the top helping the requisite engineer find the associated docs. I have proposed the syntax in the doc above yet welcome refinement.

Related, Francois is suggesting use of this to test Rust-specific references:
https://github.com/budziq/rust-skeptic
@gdanezis gdanezis added this to the Mainnet milestone Apr 30, 2022
@Clay-Mysten
Copy link
Contributor Author

Francois mentions the possibility of a Move Skeptic.

@Clay-Mysten
Copy link
Contributor Author

If we need a case study for the importance of this, see:
https://mysten-labs.slack.com/archives/C034XH78HNU

sui_programmability-refs.txt

@Clay-Mysten Clay-Mysten added Type: Documentation Improvements or additions to documentation Priority: High Very important task, not blocking but potentially delaying milestones or limiting our offering labels May 23, 2022
@Clay-Mysten
Copy link
Contributor Author

And so on...
sui_core-refs.txt
sui_programmability-framework-refs.txt

@Clay-Mysten
Copy link
Contributor Author

Let's work on link checking here too. Please see the comments in:
#1769

This was linked to pull requests May 26, 2022
Skip gateway and 127.0.0.1 address in link checker #2260
Merged
Switch GitHub link checker from weekly to daily #2259
Merged
@Clay-Mysten Clay-Mysten reopened this May 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@huitseeker huitseeker

@awelc awelc

@bmwill bmwill

@longbowlu longbowlu

@Clay-Mysten Clay-Mysten

Labels
Priority: High Very important task, not blocking but potentially delaying milestones or limiting our offering Type: Documentation Improvements or additions to documentation
Projects
None yet
Milestone
[G] Mainnet
6 participants
@huitseeker @awelc @gdanezis @bmwill @longbowlu @Clay-Mysten