Skip to content
This organization was marked as archived by an administrator on Jan 3, 2024. It is no longer maintained.
@how-do-i-docs

How Do I Docs?

The quick and easy site to help you get started with your project's docs!

How Do I Docs?

A one-stop shop to go from zero to bare-minimum project documentation!

Site Source · Design · Documentation · Templates


How Do I Docs is a site that serves as a one-stop shop for hackathon participants to learn what they need to know about documentation.

Too often, hackathon projects are left entirely undocumented, meaning that they can't be easily iterated on after the fact, and good projects don't get the appreciation they would otherwise warrant. While a full suite of documentation, like one would find in a large open-source project, is helpful, it's unrealistic in a "move-fast-break-things" setting like a hackathon. As such, I wanted to curate a resource that not only encourages hackathon participants to document their projects, but provides a slimmed down subset of templates and concepts as well as a simple starting point to make adding a docs website to a project easy.

Pinned Loading

  1. design design Public archive

    Repository housing design details for "How Do I Docs?"

  2. doc-templates doc-templates Public archive

    Documentation templates for How Do I Docs | Adaptations of templates by The Good Docs Project

  3. just-the-docs-template just-the-docs-template Public archive

    Forked from just-the-docs/just-the-docs-template

    One-click template to use just-the-docs on GitHub Pages, modified with "How Do I Docs" templates

    Ruby

  4. site site Public archive

    A one-stop shop to go from zero to bare-minimum project documentation!

    HTML

Repositories

Showing 6 of 6 repositories
  • docs Public archive

    Documentation for How Do I Docs | Built on Just the Docs

    how-do-i-docs/docs’s past year of commit activity
    Ruby 0 MIT 0 0 2 Updated Dec 28, 2023
  • site Public archive

    A one-stop shop to go from zero to bare-minimum project documentation!

    how-do-i-docs/site’s past year of commit activity
    HTML 0 MIT 0 0 0 Updated Oct 8, 2023
  • design Public archive

    Repository housing design details for "How Do I Docs?"

    how-do-i-docs/design’s past year of commit activity
    0 MIT 0 0 0 Updated Oct 8, 2023
  • .github Public archive

    Profile README for How Do I Docs

    how-do-i-docs/.github’s past year of commit activity
    0 0 0 0 Updated Oct 8, 2023
  • just-the-docs-template Public archive Forked from just-the-docs/just-the-docs-template

    One-click template to use just-the-docs on GitHub Pages, modified with "How Do I Docs" templates

    how-do-i-docs/just-the-docs-template’s past year of commit activity
    Ruby 0 MIT 103 0 0 Updated Oct 8, 2023
  • doc-templates Public archive

    Documentation templates for How Do I Docs | Adaptations of templates by The Good Docs Project

    how-do-i-docs/doc-templates’s past year of commit activity
    0 0 0 0 Updated Oct 8, 2023

People

This organization has no public members. You must be a member to see who’s a part of this organization.

Top languages

Loading…

Most used topics

Loading…