Create Documentation-Principles.md#69
Open
chexxor wants to merge 15 commits intochexxor-header-change-context-narrativefrom
Open
Create Documentation-Principles.md#69chexxor wants to merge 15 commits intochexxor-header-change-context-narrativefrom
chexxor wants to merge 15 commits intochexxor-header-change-context-narrativefrom
Conversation
Contributor
JordanMartinez
left a comment
JordanMartinez
left a comment
There was a problem hiding this comment.
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. |
Contributor
There was a problem hiding this comment.
I'm really not sure what this is trying to say. Could you clarify?
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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