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

Clarify the relationship between the Pug Website repo and the Pug documentation repo. #29

Open
audreytoskin opened this issue Feb 13, 2017 · 0 comments

Comments

@audreytoskin
Copy link

audreytoskin commented Feb 13, 2017

At first glance, it seems like the repositories pug-www, pug-en, and pug-zh-cn might all be the same thing. I mean, I think I was able to figure it out: From looking through the pug-www and pug-en repositories, I gather that the Pug documentation repos contains most of the actual content (the language and API spec), and the Pug website repo adds some extra templates and scripts for presenting the documentation online. Still, it might help to state in their respective READMEs what role each repository serves. Users who see a typo in the documentation, or a bug in the interactive code examples, might rush to the wrong repository and get confused.

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

1 participant