Setup A Local Documentation Environment

GitHub Account

1. Go to Github

2. Create (personal) GitHub Account

Docker Desktop

1. Go to Docker Website

2. Download & Install Docker Desktop

Visual Studio Code

1. Go To Visual Studio Code

2. View Menu

3. Choose Extensions

4. Install Docker and Dev Containers extensions

Github Desktop

1. Go To Github Desktop

2. Download Github Desktop

3. Install Github Desktop

4. Sign-in with Github Credentials

Github Desktop

WIP

Downloading the Docs Repo

Cloning the Repository

1. Sign-in to Github Desktop
   • Connect to the https://github.com/Y-Foundry-DAO/ repository
   • Filter Repositories by yfd-docs

2. Clone yfd-docs

3. Change Branch
   • Create New Branch
   • Give Branch a Name
   • Publish Branch
4. Click Open in Visual Studio Code
   • Choose Trust the Authors

WIP

Obsolete

While this documentation serve it’s purpose; new documentation is being written to improve the experience.

---

Building the Docker Image + Container

1. Command+Shift+P (Mac) or Ctrl+Shift+P (Linux/Windows)
   • Dev Containers: Open Folder in Container
     • click the Open button in the dialog window
     • Select From Dockerfile
2. The Development Container will now build
   • Progress can be observed by clicking the blue View Logs text in the lower right corner
   • This process can take 5-10 minutes

Create a new terminal in the VSC Console

1. Click the Plus Icon to open a new Container Terminal in VSC

Running the Jekyll Engine

1. Type ./start_yfd_docs.sh
2. Press Enter

Preview of Running YFD-Docs Instance

WIP

1. Open Visual Studio Code

2. File menu ( CTRL+O )
   • Open Folder...

3. Navigate to the yfd-docs repo folder and click open

4. Open Panel CTRL+J

5. Click the down arrow next to + on the right side to open a new:
   • Mac: Terminal
   • Windows: Command Prompt
   • Linux: Bash

the section above needs clarification on the actions

WIP

1. Type the following in the Terminal:
   • Linux or Mac: make build then make start
   • Windows: build then start
2. Navigate your browser to: http://localhost:4000 to view yfd-docs