Building a DuckDB Playground with Daytona

[c0d33ngr]

Writer's Checklist

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.

Interlinking

• Use CTRL+F to search for relevant keywords in:
  • Daytona Dotfiles Sitemap
  • Daytona Definitions Sitemap
• Interlink keywords using the appropriate URLs.

Glossary/Definitions

• Create new definition in /defitnitions folder.

Review and Edit

• Ensure articles address the needs of the target audience and their search intent.
• Read the article out loud to catch any awkward phrasing.
• 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.

[c0d33ngr]

PR to close #57

/claim #57

[c0d33ngr]

You mind reviewing this PR too @mojafa ?
Any additional suggestions is welcome

[mojafa]

@c0d33ngr here's my review:

• There are no images in your guide.
• make sure the PR name matches the issue name: Building a DuckDB Playground with Daytona
• there are many broken links or raw file references in your guide. See screenshots.
• This Step 8: Export economic data to CSV doesn't work. See screenshots.
• Step 2: Analysis and Visualization of Client Age by Educational Level doesnt work. See screenshot.
• Step 3: Analysis and Visualization of Contact Duration and Campaign Outcome through Correlation doesn't work

Please fix the issues.

[c0d33ngr]

@mojafa thanks for the review. I'll fix them

[c0d33ngr]

Please assign me to the issue @mojafa

[mojafa]

Done

[mojafa]

@c0d33ngr any updates?

[c0d33ngr]

Hi @mojafa sorry for the delays

I think I've updated most of the issues you found in the PR. The one remaining ones should be the broken links

[c0d33ngr]

@mojafa I think what you meant of broken link or raw reference is as a result of the spacing between some .md files in the definitions directory in Daytona content repo here. GitHub markdown isn't friendly with spacing between file name of markdowns - they prefer dash or underscore

Some markdown files in Datyona definition directory has spacing between their names and including dashes or underscore won't point to the file in Daytona CMS - I think so

[c0d33ngr]

@mojafa what do you think?

[c0d33ngr]

@mojafa @nkkko please you mind reviewing my PR?😊🙏

[mojafa]

@c0d33ngr please fix these 👆🏽

[c0d33ngr]

@mojafa I've fixed them with %20

[mojafa]

@c0d33ngr this PR fails DCO checks

[c0d33ngr]

@c0d33ngr this PR fails DCO checks

oh.. I did it from GitHub web with my phone

[mojafa]

please fix

[mojafa]

Take your time, don't be in a hurry. Quality of speed

[mojafa]

@c0d33ngr also please run:
npm install -g markdownlint-cli and then npx markdownlint "**/*.md" to see where your Content Compliance Checks are failing.

but mostly here:
Heading Structure Errors

• MD025/single-title/single-h1: Multiple top-level (H1) headings in the same document.
• MD041/first-line-heading/first-line-h1: The first line in a file should be a top-level heading (H1).
• MD022/blanks-around-headings: Headings should be surrounded by blank lines.
• MD036/no-emphasis-as-heading: Emphasis (bold or italic) used instead of a proper heading.
• MD023/heading-start-left: Headings must start at the beginning of the line.

Formatting and Style Errors

• MD009/no-trailing-spaces: Trailing spaces at the end of lines.
• MD012/no-multiple-blanks: Multiple consecutive blank lines; typically, only one blank line is expected.
• MD004/ul-style: Unordered list style inconsistency (e.g., using asterisks * instead of dashes -).
• MD007/ul-indent: Incorrect indentation for unordered lists.
• MD010/no-hard-tabs: Hard tabs (\t) used instead of spaces.
• MD034/no-bare-urls: Bare URLs used without proper formatting.
• MD038/no-space-in-code: Spaces inside inline code spans.
• MD029/ol-prefix: Incorrect ordered list item prefix.
• MD039/no-space-in-links: Spaces inside link text.
• MD049/emphasis-style: Inconsistent emphasis style (e.g., mixing underscores _ and asterisks *).