Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GitHub Wiki? #6

Closed
dufferzafar opened this issue Apr 3, 2014 · 6 comments
Closed

GitHub Wiki? #6

dufferzafar opened this issue Apr 3, 2014 · 6 comments

Comments

@dufferzafar
Copy link
Contributor

As of now, you need to browse the repository to read stuff.

A wiki might me a better way of displaying our content as reading it feels more 'natural'.

@mathiasbynens
Copy link
Member

As of now, you need to browse the repository to read stuff.

That is by design. Isn’t it how hackers are used to reading (code)? Also note that it’s not just about reading prose in this case; this repository contains source files for CTF challenges and the only way to have those be visible in an easily recognizable way is to just have users browse the repository.

A wiki might me a better way of displaying our content as reading it feels more 'natural'.

For reading prose, maybe. But see above.

@mathiasbynens mathiasbynens changed the title Github Wiki? GitHub Wiki? Apr 3, 2014
@mathiasbynens
Copy link
Member

The above applies to the https://github.com/ctfs/write-ups repository, but as this repository is part of the same organisation, I think it makes sense for them to use a similar structure.

@cabreraalex
Copy link
Member

I also think that at the stage the repository is at now it is much easier to write and organize in a github repository than in a wiki. If it eventually gets to an unmanageable level of complexity, we can transfer it over to a wiki-like structure or website and conserve the work that has been done here.

For now I'm going to keep working on it in the same manner in which the write-ups are, as it seems to have been working well and most people don't find it too challenging to navigate the Github folder structure

@dufferzafar
Copy link
Contributor Author

I don't actually have any experience with Github Wikis and just hope that converting a stack of README files to a wiki format is easy because I really feel that the content will reach a decent level of complexity.

@cabreraalex
Copy link
Member

just saw this: http://www.gitbook.io/

Although this repo is not a book, might be interesting to build off of that

@dufferzafar
Copy link
Contributor Author

Yeah, it looks nice.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants