Beanstalk Notion
Beanstalk Notion
✏️

Updating the Whitepapers

Category
Docs
Last edited by
guy
Last edited time
Dec 18, 2022 7:34 AM

Process

  1. Duplicate the original Overleaf project and name your new project something relevant to the changes you are making. Save a PDF of the previous whitepaper version.
    1. This preserves the LaTeX for the past version and will be the PDF you use to compare with your changes.
  2. Make changes to the whitepaper on your new project, following the Rules below.
  3. Do a final PDF compare on https://draftable.com/compare to ensure it has only the changes you expect and that all changes are account for in the Version History.
  4. Once it’s finalized, copy paste the LaTeX from each file in your new project to the original Overleaf project (which is the one connected to GitHub)
  5. In order to push from Overleaf to GitHub:
    1. In the original project → Menu → GitHub → Push changes to GitHub → add commit message.
  6. Then finally, update the whitepaper according to Places to Update section.

Places to Update

beanstalk.pdf

  1. Beanstalk Landing Repo
    1. version number: https://github.com/BeanstalkFarms/Beanstalk-Landing/blob/master/pages/index.tsx#L133
    2. PDF: https://github.com/BeanstalkFarms/Beanstalk-Landing/blob/master/public/beanstalk.pdf
  2. Beanstalk Repo
    1. version number: https://github.com/BeanstalkFarms/Beanstalk/blob/master/readme.md?plain=1#L11
    2. PDF: https://github.com/BeanstalkFarms/Beanstalk/blob/master/beanstalk.pdf
  3. Beanstalk Whitepaper Repo
    1. PDF: https://github.com/BeanstalkFarms/Beanstalk-Whitepaper/blob/master/beanstalk.pdf
    2. Add the previous version of the Whitepaper with a filename according to the format in this directory: https://github.com/BeanstalkFarms/Beanstalk-Whitepaper/tree/master/version-history

pipeline.pdf

  1. Pipeline Landing Repo
    1. PDF: https://github.com/BeanstalkFarms/Pipeline-Landing/blob/master/public/pipeline.pdf
  2. Pipeline Repo
    1. version number: https://github.com/BeanstalkFarms/Pipeline/blob/master/README.md?plain=1#L8
    2. PDF: https://github.com/BeanstalkFarms/Pipeline/blob/master/pipeline.pdf
  3. Root Whitepaper Repo
    1. PDF: https://github.com/BeanstalkFarms/Pipeline-Whitepaper/blob/master/pipeline.pdf
    2. Add the previous version of the Whitepaper with a filename according to the format in this directory: https://github.com/BeanstalkFarms/Pipeline-Whitepaper/tree/master/version-history

root.pdf

  1. Root UI Repo (private)
    1. PDF: https://github.com/RootToken/ui/blob/main/public/root.pdf
  2. Root Repo
    1. version number: https://github.com/RootToken/Root/blob/master/README.md?plain=1#L8
    2. PDF: https://github.com/RootToken/Root/blob/master/root.pdf
  3. Root Whitepaper Repo
    1. PDF: https://github.com/RootToken/Root-Whitepaper/blob/master/root.pdf
    2. Add the previous version of the Whitepaper with a filename according to the format in this directory: https://github.com/RootToken/Root-Whitepaper/tree/master/version-history

Rules

Verbiage

  • You don’t want to use a term that isn’t defined. If you are going to use a term, you need to explicitly say what they are. Otherwise, don’t bother mentioning them by name.
  • English Sentences end with periods
  • Minimal words used without any loss of necessary information
  • Do not explain why or how. Explain what is.
  • Oxford commas or optional, depending on clarity. Typically don’t need them.
  • “Can” is better than “must”

Formatting

  • Make sure all Beanstalk terms are italicized
  • Make sure all code is in code formatting
  • Paragraphs are never cut off in middle by a page break
  • Sections are nicely ordered by page
  • No huge blank spaces
  • Don’t over crunch text together
  • Image sizes are consistent and optimal
  • Always do a final formatting walkthrough to confirm

Version History

  • Mimic language patters from previous changes; do not ad lib.
  • Do a PDF compare (https://draftable.com/compare) with current version and draft version to confirm no changes are missed in the Whitepaper Version History
  • Order the Version History section in the order the changes appear in the whitepaper

Footer / Links Rules

  • The first instance BIPs are referenced should have a footnote and link
    • \footnote creates a footnote → if you click the number it takes you to where the footnote is located (doesn’t take you to another link)
    • \href links you to the specified link but you can customize the link—i.e., you can put any link and the put a vanity or summarized description if you want to. Example: you can link BIP-2 to the BIP-2 markdown with the following:
      • \href{https://bean.money/bip-2}{BIP-2}
    • \fref is a command for href without the http
      • \newcommand{\fref}[1]{\footnote{\href{http://#1}{#1}}}
\setlength{\footnotemargin}{8mm} % Spacing between footnote number and body