search

pwncollege / dojo

Infrastructure powering the pwn.college dojo
https://pwn.college
BSD 2-Clause "Simplified" License
279 stars 87 forks source link

Create PHILOSOPHY.md (or add to example-dojo docs) #360

Open zardus opened 5 months ago

zardus commented 5 months ago

An overview of our educational philosophy (as it relates to challenge/module/dojo design) would be really good to have in a place visible for new dojo authors. Probably, the best place for this is the example-dojo, maybe in its DESCRIPTION.md or just in its README.md

A good starting point would be to turn the first few sections of the PWN paper (https://sefcom.asu.edu/publications/pwn-sigcse24.pdf) into a living markdown document.

ConnorNelson commented 5 months ago

For both this and #359, I think it would be great if these docs lived in ./docs/ of this repo, and we make this static content actually visible on https://pwn.college/. Probably we could include a ABOUT.md and INDEX.md, and these all manifest on the site in a nicely linked way where they are "apart" of the site.

We can also use this opportunity to de-clutter the front page (I firmly believe there should be close to no-text on the front page, except big eye catching phrases and sentence/2 sentence captions). I guess I am taking this opportunity to again state that the front page should not be a dumping ground for everything! I'm not saying we totally copy them, but I think https://cryptohack.org is a good example of a front-page done well. Of course I also recognize that probably I am the one that will need to make that happen 😛

zardus commented 5 months ago

I guess the biggest hurdle there is overriding the / route?