Skip to content

smlhelp/book

Repository files navigation

SML Help

Thanks for checking out SML Help!

This website is built using Docusaurus, a modern static website generator.

Installation

Clone the repo, then:

$ npm install

Local Development

$ npm start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Contributing

  1. Checkout to a new branch based on master
  2. Decide what kind of resource you'd like to create, and check out what already exists
    • "Getting Started" written tutorial (look in docs/start)
    • Specification of a type or structure (docs/types)
    • Debugging Guide (docs/debugging)
    • Conceptual Notes (docs/concepts)
    • Worked example, video or written (docs/examples/written)
    • Something else (talk to Jacob if your idea doesn't fit these categories)
  3. If a page already exists (probably at docs/foo/bar.md, for some foo and bar) where you can add your content, add it there. Make sure to update the author attribution:
    • If you fixed typos and made minor edits, add "Revised <current month>" to attribution
    • If you wrote a new section or performed significant rewrites, add "Rewritten by <your name>, <current month>"
  4. If no such page exists:
    • Create the file in the appropriate docs/foo directory. Give it a short, descriptive, lowercase-alphabetical name, like minimax.md
    • Write your content (in markdown) to the file
    • Write "By <your name>, <current month>" (with a line break afterwards) beneath the page title
  5. Add, commit, push, and pull-request your changes.
  6. If your changes get approved and merged, add a separate pull request to add yourself to the list of contributors on the "About" page (if you're not on it).

About

deployment for smlhelp page

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published