Merge pull request 0xPolygon#29 from 0xPolygon/nadim/readme-running

Add clarification to README + change project name

Author: Nadim Kobeissi

README.md

@@ -1,6 +1,6 @@
-# Polygon Technical Docs
+# Polygon Knowledge Layer
 
-Welcome to the Polygon Technical Docs! This documentation is built using [the Material theme for MkDocs](https://squidfunk.github.io/mkdocs-material/). Our goal is to establish a high-quality, curated, and comprehensive "source of truth" for technical knowledge surrounding Polygon's main technology. This includes detailed sections on:
+Welcome to the Polygon Knowledge Layer! This documentation is built using [the Material theme for MkDocs](https://squidfunk.github.io/mkdocs-material/). Our goal is to establish a high-quality, curated, and comprehensive "source of truth" for technical knowledge surrounding Polygon's main technology. This includes detailed sections on:
 
 - Polygon CDK
 - Polygon zkEVM
@@ -23,7 +23,7 @@ In addition, we include top-level sections for Tools and Tutorials to support de
 
 ### Creating a pull request
 
-1. **Pull request**: Once your changes are complete, create a pull request against the main branch of Polygon Technical Docs.
+1. **Pull request**: Once your changes are complete, create a pull request against the main branch of Polygon Knowledge Layer.
 2. **Review process**: Your pull request will be reviewed by the maintainers. They may request changes or clarifications.
 3. **Responsibility**: Contributors are expected to maintain their contributions over time and update them as necessary to ensure continued accuracy and relevance.
 
@@ -45,12 +45,20 @@ Before running the site locally, you need to have the following installed:
 
 ### Setup
 
-1. **Clone repository**: Clone the Polygon Technical Docs repository to your local machine.
+1. **Clone repository**: Clone the Polygon Knowledge Layer repository to your local machine.
 2. **Create a virtual environment**: Run `virtualenv venv; source venv/bin/activate` in the root directory.
 3. **Install dependencies**: Install required Python packages with `pip3 install -r requirements.txt`.
 
 ### Running the website
 
+Before running the website, you'll need to first load the Python virtual environment in your current shell. To do this, type the following (depending on your shell):
+
+- **Bash**, **zsh** (most common): `virtualenv venv; source venv/bin/activate`
+- **Fish**: `virtualenv venv; source venv/bin/activate.fish`
+- **Nu**: `virtualenv venv; source venv/bin/activate.nu`
+
+You only need to do the above once per shell session. Then, pick one of the following:
+
 1. **MkDocs in strict mode**: Use `mkdocs serve --strict` for a production-like environment.
 2. **MkDocs in normal mode**: Use `mkdocs serve` for a less strict, more forgiving environment, suitable for debugging.
 

docs/_site_essentials/stylesheets/extra.css

@@ -41,14 +41,4 @@ div.flex-figure div.flex-figure-left {
 div.flex-figure div.flex-figure-right {
 	flex-grow: 1;
 	flex-shrink: 1.5;
-}
-
-/*
-.md-footer, .md-footer__inner, .md-footer-meta {
-	background-color: black;
-}
-*/
-
-.md-footer__inner {
-	display: none !important;
 }

mkdocs.yml

@@ -1,7 +1,7 @@
-site_name: Polygon docs
+site_name: Polygon Knowledge Layer
 site_author: Polygon Labs
 copyright: Copyright © 2023 Polygon Labs
-repo_name: Polygon docs
+repo_name: Polygon Knowledge Layer
 repo_url: https://github.com/0xPolygon/polygon-docs
 edit_uri: edit/main/docs/
 #remote_branch: gh-pages