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

[1/?] Add ability to run code examples in the playground: Move code samples to separate files #544

Merged
merged 28 commits into from
May 21, 2024
Merged

[1/?] Add ability to run code examples in the playground: Move code samples to separate files #544

merged 28 commits into from
May 21, 2024

Conversation

shaedrich
Copy link
Collaborator

See #340

Fun fact: Loading snippets from gists, would have been possible via url_download config option 😉

Key points

  • top-level /code-samples directory
  • flat structure within /code-samples
  • file names within /code-samples having the page name, they are primarily used in as a prefix
    • a few files only consist of said prefix
  • file names consist of [a-z-]
  • code samples are embedded, using the snippet feature with the two dashes each syntax (--8<--)
  • code samples are reused when the same code is used elsewhere or lines from it (snippet lines syntax). Code sample reuse, that could only be achieved by the block format is not done
  • code samples currently have no new line at EOF
  • we currently have code samples in the following languages:
    • pony (see below)
    • Bash (.sh; 13)
    • C (9)
    • Error (.txt; 3)

Progress

  • Getting Started (16 code samples, 12 unique snippets)
  • Types (46 code samples, 43 unique snippets)
  • Expressions (131 code samples, 129 unique snippets)
  • Reference Capabilities (22 code samples, 21 unique snippets)
  • Object Capabilities (6 code samples, 4 unique snippets)
  • Generics (22 code samples, 18 unique snippets)
  • Packages (8 code samples/snippets)
  • Testing (6 code samples/snippets)
  • C-FFI (34 code samples/snippets)
  • Gotchas (8 code samples/snippets)
  • Where Next?
  • Appendices (36 code samples/snippets)

= 313 code samples, 298 unique snippets

shaedrich and others added 27 commits April 21, 2024 05:35
@shaedrich
feat(config): Activate mkdocs snippets extension
765384b
@shaedrich
refactor(code-samples): Turn code samples into snippets
c1a8a22
@shaedrich
fix(config): Add missing colon
58e6599 
to mark array entry as object rather than a string
@shaedrich
feat(config): Enable check_paths option for snippets
62a001d
@shaedrich
fix(code-samples): ✏️ Fix snippet file embed path
c6b9959
@shaedrich
Merge branch 'code-samples-separate-files' of https://github.com/shae…
dc86c15 
…drich/pony-tutorial into code-samples-separate-files
@shaedrich
refactor(code-samples): 📝 Turn code samples into snippets for "Object…
70dad88 
… Capabilities" directory
@shaedrich
refactor(code-samples): 📝 Turn code samples into snippets for "Packag…
2464d02 
…es" directory
@shaedrich
refactor(code-samples): 📝 Turn code samples into snippets for "Testin…
50e60d2 
…g" directory
@shaedrich
fix(code-samples): ✏️ Fix snippet file embed path
676f5ee
@shaedrich
refactor(code-samples): 📝 Turn code samples into snippets for "Gotcha…
c0a6b17 
…s" directory
@shaedrich
fix(code-samples): ✏️ Shorten snippet line syntax
003722b
@shaedrich
refactor(code-samples): 📝 Turn code samples into snippets for "Types"…
fd48fe3 
… directory
@shaedrich
fix(code-samples): ✏️ Fix snippet file embed path
f983690
@shaedrich
fix(code-samples): ✏️ Fix snippet file name
27e0623
@shaedrich
cont'd
154c7dc
@shaedrich
refactor(code-samples): 📝 Turn code samples into snippets for "Expres…
cc8c939 
…sions" directory
@shaedrich
fix(code-samples): ✏️ Fix snippet file name
999c6c4
@shaedrich
refactor(code-samples): 📝 Turn code samples into snippets for "Refere…
706c0d0 
…nce Capabilities" directory
@shaedrich
refactor(code-samples): 📝 Turn code samples into snippets for "Generi…
cc1f53a 
…cs" directory
@shaedrich
fix(code-samples): ✏️ Fix snippet file embed path
bb74be7
@shaedrich
fix(code-samples): ✏️ Shorten snippet line syntax
2e6bc8a
@shaedrich
refactor(code-samples): 📝 Turn code samples into snippets for "C-FFI"…
57bbbeb 
… directory
@shaedrich
refactor(code-samples): 📝 Turn code samples into snippets for "Append…
5b35814 
…ices" directory
@shaedrich
fix(code-samples): ✏️ Fix snippet file name
420d05a
@shaedrich
fix(code-samples): ✏️ Fix snippet file embed path
1a22c1a
@shaedrich
.gitignore: + /.vscode
45180f5
@ponylang-main ponylang-main added the discuss during sync Should be discussed during an upcoming sync label May 8, 2024
@netlify Netlify
Copy link

netlify bot commented May 8, 2024 •
edited
Loading

✅ Deploy Preview for pony-tutorial ready!

Name Link
🔨 Latest commit db1eb11
🔍 Latest deploy log https://app.netlify.com/sites/pony-tutorial/deploys/6644d8e99fad65000711bba1
😎 Deploy Preview https://deploy-preview-544--pony-tutorial.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@shaedrich shaedrich mentioned this pull request May 8, 2024
Closed
12 tasks
jemc
jemc approved these changes May 9, 2024
View reviewed changes
Copy link
Member

@jemc jemc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks mostly good to go - I just had the one question above about non-Pony-source-code samples.

jemc
jemc requested changes May 14, 2024
View reviewed changes
code-samples/ponypath-unix-mac.sh Outdated Show resolved Hide resolved
@shaedrich shaedrich mentioned this pull request May 15, 2024
Draft
@shaedrich shaedrich requested a review from jemc May 16, 2024 00:23
This was referenced May 16, 2024
Open
Merged
Closed
Merged
@jemc jemc merged commit caae6e2 into main May 21, 2024
17 checks passed
@jemc jemc deleted the code-samples-separate-files branch May 21, 2024 18:08
@ponylang-main ponylang-main removed the discuss during sync Should be discussed during an upcoming sync label May 21, 2024
shaedrich added a commit to shaedrich/pony-tutorial that referenced this pull request May 21, 2024
@shaedrich
refactor(code-samples): 📝 Revert non-pony code samples
3339fd2 
Co-authored-by: Joe Eli McIlvain <[email protected]>

As requested in ponylang#544 (comment)

From db1eb11
shaedrich added a commit to shaedrich/pony-tutorial that referenced this pull request May 22, 2024
@shaedrich
refactor(code-samples): 📝 Revert non-pony code samples
937c90e 
Co-authored-by: Joe Eli McIlvain <[email protected]>

As requested in ponylang#544 (comment)

From db1eb11
shaedrich added a commit to shaedrich/pony-tutorial that referenced this pull request May 22, 2024
@shaedrich
Revert non-pony error message code samples
469dabf 
Co-authored-by: Joe Eli McIlvain <[email protected]>

As requested in ponylang#544 (comment)

From db1eb11

Follow-up to 3339fd2
shaedrich added a commit to shaedrich/pony-tutorial that referenced this pull request May 22, 2024
@shaedrich
Revert non-pony error message code samples
0bc061c 
Co-authored-by: Joe Eli McIlvain <[email protected]>

As requested in ponylang#544 (comment)

From db1eb11

Follow-up to 3339fd2
@shaedrich shaedrich mentioned this pull request Jun 5, 2024
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jemc jemc jemc 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
@shaedrich @jemc @ponylang-main