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

Draft: documentation #99

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

Draft: documentation #99

wants to merge 9 commits into from

Conversation

Abbe98
Copy link
Collaborator

@Abbe98 Abbe98 commented Mar 29, 2024

The README has grown very long even through there is much more documentation needed.

The Snowman manual/documentation is supposed to be both a comprehensive guide to using Snowman and a reference for all the features and commands available in Snowman. This is the start of that.

  • Basic documentation structure
  • Introduction
  • Installation
  • Quick start
  • Reference
    • CLI
    • Template functions
    • Configuration
  • Recipes

Tier 2 (very optional for now):

@Abbe98 Abbe98 self-assigned this Mar 29, 2024
@Abbe98 Abbe98 marked this pull request as draft March 29, 2024 10:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant