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

Interactive TypeScript Notebooks in Daytona with Srcbook #99

Merged
merged 10 commits into from
Dec 13, 2024

Conversation

oreoluwa212
Copy link
Contributor

@oreoluwa212 oreoluwa212 commented Sep 10, 2024

Writer's Checklist

/claim #51
Click to watch demo
link to srcbooks devcontainer repo

Writing Structure

  • Use short sentences and paragraphs, and include bucket brigades.
  • Include more than two descriptive H2 headings to organize content.
  • Capitalize headings according to the AP Stylebook (use this tool)
  • Include an introduction with at least two paragraphs before the first H2 section.
  • Use appropriate formatting (bold, italic, underline), notes, quotes, TLDRs, and key points.
  • Incorporate code elements and Markdown format where appropriate.
  • Ensure at least one visual element per “screen” of the article (screenshots, diagrams, tables, graphs, lists, sidenotes, blockquotes).

Fact-Checking

  • Verify all facts and data points included in the article.

Asset Management

  • Save images in the /assets folder.
  • Follow naming conventions: YYYYMMDD_title_of_the_article_IMG_NAME_NO.png.
  • Optional) Create a GitHub repo for the code referenced in the article and share it.
  • (Optional) Include a link to this Loom video in the PR comments.

Review and Edit

  • Run the draft through Grammarly or a similar grammar tool.
  • Double-check adherence to the style guide and repository guidelines.
  • Use the name of the article for the title of the PR.

Copy link

algora-pbc bot commented Sep 10, 2024

💵 To receive payouts, sign up on Algora, link your Github account and connect with Stripe.

@oreoluwa212 oreoluwa212 force-pushed the srcbook-guide branch 2 times, most recently from a2709af to f452229 Compare September 11, 2024 22:47
@oreoluwa212
Copy link
Contributor Author

@nkkko Issue has been worked out and documentation is ready for review

@oreoluwa212
Copy link
Contributor Author

@mojafa been ready for review. Kindly check. Thank you

@mojafa
Copy link
Collaborator

mojafa commented Nov 14, 2024

You've submitted 2 PRs, let's close one successfully first.

This one: #108 (review)

@oreoluwa212
Copy link
Contributor Author

@mojafa the other PR has been merged successfully

@mojafa
Copy link
Collaborator

mojafa commented Nov 20, 2024

@oreoluwa212 your guide works well but somewhat misses to address the PR. https://github.com/daytonaio/content/issues/51

  • Using Daytona to create and run a Srcbook project
  • Tips for effective use of Srcbook in a Daytona environment

please add some sample code to run a test. The current project juts has the devcontainer.json file. I'd like to see some mini project.

Equally, please share tips for effective use of srcbook in a Daytona environment.

Screenshot 2024-11-20 at 23 14 03

@oreoluwa212
Copy link
Contributor Author

@oreoluwa212 your guide works well but somewhat misses to address the PR. https://github.com/daytonaio/content/issues/51

  • Using Daytona to create and run a Srcbook project
  • Tips for effective use of Srcbook in a Daytona environment

please add some sample code to run a test. The current project juts has the devcontainer.json file. I'd like to see some mini project.

Equally, please share tips for effective use of srcbook in a Daytona environment.

Screenshot 2024-11-20 at 23 14 03

Thank you for your feedback, getting into addressing them now

@mojafa
Copy link
Collaborator

mojafa commented Nov 20, 2024

No worries

@mojafa
Copy link
Collaborator

mojafa commented Nov 25, 2024

@oreoluwa212 any updates?

@oreoluwa212
Copy link
Contributor Author

I am stuck at the clause of having a mini typescript project in the same folder where devcontainer is, given that the whole point of srcbook is to use this tool (AI) to generate js/ts code

@oreoluwa212
Copy link
Contributor Author

Or can I build a mini app (not necessarily in the repo) using the launched srcbook using Daytona, will this count? @mojafa

@mojafa
Copy link
Collaborator

mojafa commented Nov 25, 2024

@oreoluwa212 did you add

Tips for effective use of Srcbook in a Daytona environment

@oreoluwa212
Copy link
Contributor Author

@oreoluwa212 did you add

Tips for effective use of Srcbook in a Daytona environment

yes, PR has been updated, kindly review @mojafa

Signed-off-by: oreoluwa212 <[email protected]>
Signed-off-by: oreoluwa212 <[email protected]>
Signed-off-by: oreoluwa212 <[email protected]>
Signed-off-by: oreoluwa212 <[email protected]>
Signed-off-by: oreoluwa212 <[email protected]>
@mojafa
Copy link
Collaborator

mojafa commented Dec 4, 2024

@oreoluwa212 I wanted to let you know that I've just pushed some changes to the main branch that fix some linting issues and update the compliance rules. These updates should help you pass the content compliance checks in your current pull request.

When you get a chance, please pull the latest changes from the main branch into your working branch. This should make the integration smoother and help avoid any potential conflicts.

@mojafa
Copy link
Collaborator

mojafa commented Dec 4, 2024

Hey @oreoluwa212 this is a goood one!

I was able to run everything as expected.

Just a slight issue though.

  • Please add this as a screenshot on how to forward ports from the remote container. SOme users might struggle to get to the srcbook site
Screenshot 2024-12-05 at 02 27 39
  • You missed this bit where it asks users to add api_keys from this different ai tools
Screenshot 2024-12-05 at 02 27 17
  • Add a screenshot for this as well. Like an example of your code working in the srcbook
Screenshot 2024-12-05 at 02 31 48

@mojafa
Copy link
Collaborator

mojafa commented Dec 6, 2024

@oreoluwa212 This branch has conflicts that must be resolved.
Alos it's failing content comapliance check.

Let's fix those as well.

@oreoluwa212
Copy link
Contributor Author

@oreoluwa212 This branch has conflicts that must be resolved. Alos it's failing content comapliance check.

Let's fix those as well.

@mojafa these changes have been implemented, kindly review

@mojafa
Copy link
Collaborator

mojafa commented Dec 7, 2024

Nice

@oreoluwa212
Copy link
Contributor Author

@mojafa any issues with PR?

@nkkko nkkko merged commit b5b68d7 into daytonaio:main Dec 13, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants