You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Then someone who had followed the deep link into the code and may cut and paste the text into their own project, can follow it back to the documentation. The demo code can provide its own context to help advertise the project, rather than being a browsing cul-de-sac that doesn't lead deeper into the project.
Certainly, the end users could click up though the header to docs and drill back down to the specific concept being documented, but the direct lateral link directly from the demos to deep into the specific part of the documentation provides a lot more information-value-per-click and use the demos keep the eyes of the users on the project.
Add to the comment in the example code so when a user is viewing the polyround demo in the documentation, so the user, and anyone who uses cut-and-paste code from this demo, has a high-quality deep link back to the documentation and project.
Per Irev-Dev/cadhub#613
It might be nice to add links to the demos on CadHub, like https://cadhub.xyz/u/irevdev/round-anything-demo/ide back to the documention it is aimed at, such as https://learn.cadhub.xyz/docs/round-anything/api-reference#polyround
If the doc https://learn.cadhub.xyz/docs/round-anything/api-reference#polyround links into the hub with https://cadhub.xyz/dev-ide/openscad#fetch_text_v1=https%3A%2F%2Fraw.githubusercontent.com%2FIrev-Dev%2FRound-Anything%2Fmaster%2Fexamples%2Fpolyround.scad , then the code shown in the IDE should back link to the documentation like
Then someone who had followed the deep link into the code and may cut and paste the text into their own project, can follow it back to the documentation. The demo code can provide its own context to help advertise the project, rather than being a browsing cul-de-sac that doesn't lead deeper into the project.
Certainly, the end users could click up though the header to docs and drill back down to the specific concept being documented, but the direct lateral link directly from the demos to deep into the specific part of the documentation provides a lot more information-value-per-click and use the demos keep the eyes of the users on the project.
Edit: I see the code is at https://github.com/Irev-Dev/Round-Anything/blob/master/examples/polyround.scad
What I'm asking is that https://github.com/Irev-Dev/Round-Anything/blob/master/examples/polyround.scad would have a link to https://learn.cadhub.xyz/docs/round-anything/api-reference#polyround in its comment.
The text was updated successfully, but these errors were encountered: