-
Couldn't load subscription status.
- Fork 0
Create Documentation-Principles.md #69
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
base: chexxor-header-change-context-narrative
Are you sure you want to change the base?
Create Documentation-Principles.md #69
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a few general comments.
Since I'm not really sure where this is going, I don't know whether I can really give helpful feedback.
| ## Documentation Scope | ||
|
|
||
| - There are many types of applications that can be built with PureScript, each of which should have documentation. The group of people who write each type of application is best suited for managing its documentation. | ||
| - All types of PureScript applications have pre-requisite knowledge, and the set of this knowledge which is common across all PureScript applications should be managed by the group of PureScript groups, an entity which we will name the PureScript organization. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm really not sure what this is trying to say. Could you clarify?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps also addressed by ef38c4a?
Rather than getting stuck on the Context/Narrative step, perhaps working on the next steps will create more context with which to judge the content of that step. So, here's a start for the Principles step. It needs a lot more work, I think.
I started from the principles I generated when working on a past project of mine: https://github.com/commercial-purescript/documentation/blob/master/README.md