This guide takes you from a blank file to a pull request on the Memo repository. The steps run in order: pick a folder, set up and sync your environment, write, preview, get a review, commit and open the pull request.
1Choose the right directory
First decide which field you are writing in. Whether you write about blockchain, communication, design, engineering, market, security or writing, there is a directory for it in playground.
If you are unsure where your content fits, message our supporters on Discord. If you still do not know where to place the note, leave it in vault/playground/00_fleeting.
2Set up and sync
Before you create a post, make sure you have finished setting up the environment for editing Memo, as described in this post. Make sure you also have the right access to edit the memo.d.foundation repository.
Every time you edit or create a post, update your local files first. Go to Source Control and sync all changes in the memo.d.foundation repository.
3Create the post
- Choose the folder to nest your post in (see step 1).
- Click the New file icon and enter the file name. Add the .md suffix so the file is typed as Markdown.
- Insert the metadata at the top of the post:
---
title: [The title]
date: yyyy-mm-dd
description: [your description]
authors: [your name]
tags:
- [tag1]
- [tag2]
- [tag3]
---
Every article needs these mandatory fields: title, description, author, date and tags.
- Write your post below the metadata.
- Save the file with Cmd+S.
Follow these rules while you write:
- Name your files in kebab case, for example how-to-write-a-memo.md.
- Verify all links in your article by running the repository locally.
- Upload any images to the assets folder and reference them from there.
- For image and screenshot guidelines, read this guide.
4Preview locally
To preview your changes on the website, open Devbox by running devbox shell in Terminal. Then run make watch-run and open the localhost link.
5Get a review
Tell a reviewer whether your article is a draft or the final version. Capture the whole page of your post on the local link and send it to your supervisor and @anna to review. We suggest the Scrolling Capture feature of Cleanshot.
- Content: our experts review and improve your work. For example, @tom handles engineering and @nikki focuses on communications.
- Format and design: @anna oversees the visual and structural aspects. When you are done, take a screenshot, upload it to our server and ping @anna for feedback.
Gather all the feedback and work through it. For detailed instructions, read Life cycle of a publication.
6Commit your changes
Until you commit, your post exists only in local files. To publish it, you create a request for an administrator to approve. Commit all changes first:
- Go to the Source control section.
- Sync all changes in memo.d.foundation and in the branch you edited.
- Stage all changes of the branch you edited.
- Name the commit and press Commit.
7Create the pull request
Go to your GitHub and log in. Then:
- Open the profile dropdown and open the Your repositories section.
- Choose the branch you edited.
- Open the pull request list.
- Choose the commit and create the pull request.
Now wait for an admin to review your request.