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

Implement new setup for code snippets #2399

Closed
Tracked by #2504 ...
arboleya opened this issue May 28, 2024 · 1 comment · Fixed by #2651
Closed
Tracked by #2504 ...

Implement new setup for code snippets #2399

arboleya opened this issue May 28, 2024 · 1 comment · Fixed by #2651
Assignees
Labels
docs Requests pertinent to documentation

Comments

@arboleya
Copy link
Member

arboleya commented May 28, 2024

Pooblem

In the past, we had a couple of issues involving code snippets:

Examples

They can be missing imports, have invalid syntax, etc. We must improve our handling of these to ensure that the code chunks we provide in the docs are 100% reliable.

comment

comment2


Propoal

I outlined a proposal for it in this discussion — #2159 (comment).

Here's a quick PoC for it — https://github.com/arboleya/docs-widgets.

@arboleya arboleya added the docs Requests pertinent to documentation label May 28, 2024
@arboleya arboleya added this to the Mainnet milestone Jun 9, 2024
@arboleya arboleya removed the mainnet label Jun 9, 2024
@arboleya arboleya added epic and removed epic labels Jun 12, 2024
@arboleya arboleya modified the milestones: 0.x mainnet, 0.x post-launch Jun 12, 2024
@arboleya arboleya mentioned this issue Jun 12, 2024
16 tasks
@arboleya arboleya changed the title Revamp Code Snippets Implement new setup for code snippets Jun 12, 2024
@arboleya arboleya mentioned this issue Jun 12, 2024
2 tasks
@arboleya arboleya self-assigned this Jun 30, 2024
@arboleya arboleya modified the milestones: 0.x post-launch, 1.0 caterpillar, 0.x mainnet Jun 30, 2024
@arboleya

This comment was marked as resolved.

@arboleya arboleya removed this from the 0.x mainnet milestone Jul 19, 2024
@arboleya arboleya removed the blocked label Jul 20, 2024
@arboleya arboleya removed the p1 label Aug 2, 2024
@arboleya arboleya added this to the Caterpillar v1 milestone Aug 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Requests pertinent to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant