Skip to content

CU-ESIIL/Working-Group-Guide

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ESIIL Working Group Guide

This repository is a documentation template for ESIIL working groups. It uses MkDocs + Material to publish a clean guide from the request for proposals through final reporting.

It includes:

  • a public documentation website built from docs/
  • guide pages for the RFP, FAQ, applicants, new groups, active groups, final reporting, and reusable templates
  • ESIIL-styled visual defaults for MkDocs Material
  • automatic deployment to GitHub Pages using GitHub Actions
  • an AGENTS.md file with repository guidance for AI coding agents

The website is built from the docs/ folder and automatically deployed when changes are pushed.


Enable the Website

After creating a repository from this template you must enable GitHub Pages once.

  1. Go to Settings → Pages
  2. Under Build and deployment, choose Source: GitHub Actions

The site will then deploy automatically on push.

Your site will appear at:

https://<your-username>.github.io/<repository-name>/

Preview Locally

pip install mkdocs mkdocs-material
mkdocs serve

Then open:

http://127.0.0.1:8000

Use this template as the documentation layer for an ESIIL working group, then add only the pages and examples the group needs.

About

documentation webpage

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Generated from CU-ESIIL/basic_OASIS