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

Transcription guide #163

Draft
wants to merge 32 commits into
base: main
Choose a base branch
from
Draft

Conversation

c0d33ngr
Copy link
Contributor

@c0d33ngr c0d33ngr commented Feb 11, 2025

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

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.

/claim #13 and to close #13

Signed-off-by: Jeffrey <[email protected]>
Signed-off-by: Jeffrey <[email protected]>
Signed-off-by: Jeffrey <[email protected]>
Signed-off-by: Jeffrey <[email protected]>
Signed-off-by: Jeffrey <[email protected]>
Signed-off-by: Jeffrey <[email protected]>
Signed-off-by: Jeffrey <[email protected]>
Signed-off-by: Jeffrey <[email protected]>
Signed-off-by: Jeffrey <[email protected]>
Signed-off-by: Jeffrey <[email protected]>
Signed-off-by: Jeffrey <[email protected]>
Signed-off-by: Jeffrey <[email protected]>
Signed-off-by: Jeffrey <[email protected]>
Signed-off-by: Jeffrey <[email protected]>
Signed-off-by: Jeffrey <[email protected]>
Signed-off-by: Jeffrey <[email protected]>
Signed-off-by: Jeffrey <[email protected]>
Signed-off-by: Jeffrey <[email protected]>
Signed-off-by: Jeffrey <[email protected]>
Signed-off-by: Jeffrey <[email protected]>
Signed-off-by: Jeffrey <[email protected]>
Signed-off-by: Jeffrey <[email protected]>
Signed-off-by: Jeffrey <[email protected]>
Signed-off-by: Jeffrey <[email protected]>
@c0d33ngr
Copy link
Contributor Author

Hi @nkkko, do you think this PR meet your taste? Please also check this too from another of my branch
I just want to be sure I am in the right track before adding title description, images, how to transcribe in details, definitions and others if any pop up

@nkkko
Copy link
Member

nkkko commented Feb 11, 2025

hey, the other article in the other branch is better, but general gist should be how to prototype and build ai enabled tools, essentially you are demoing how to build ai enabled tools on the case of whisper, sapat project should only be considered as demo. Considering this the other article is better. Also general note TLDR is not TOC. TLDR needs to be 3-4 lines of overview of the article, key learnings, etc.

@c0d33ngr
Copy link
Contributor Author

c0d33ngr commented Feb 11, 2025 via email

Signed-off-by: Jeffrey <[email protected]>
Signed-off-by: Jeffrey <[email protected]>
Signed-off-by: Jeffrey <[email protected]>
@c0d33ngr c0d33ngr marked this pull request as draft February 14, 2025 08:25
Signed-off-by: Jeffrey <[email protected]>
@c0d33ngr c0d33ngr force-pushed the transcription-guide branch from d3cdd8b to 048467d Compare February 14, 2025 16:56
Signed-off-by: Jeffrey <[email protected]>
Signed-off-by: Jeffrey <[email protected]>
@c0d33ngr
Copy link
Contributor Author

You still think I'm in track @nkkko ?

Signed-off-by: Jeffrey <[email protected]>
@c0d33ngr
Copy link
Contributor Author

@nkkko are you okay with this content of the draft?

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.

AI Transcription Tool
2 participants