Streamline main readme, and update website versioning #275
Conversation
This file contains 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
rikoe
force-pushed
the
feat/streamline-main-readme
branch
from
7a72a21 to
4ce8895
Compare
rikoe
force-pushed
the
feat/streamline-main-readme
branch
2 times, most recently
from
bd08a3b to
779e9dd
Compare
- add clickable FDC3 logo at top of README that goes to fdc3.finos.org - simplify description of FDC3 and link to the four specifications that make up the standard, and use cases - add installation and usage sections to the README that concisely demonstrate how to use FDC3 - add a documentation section that explicitly links to the documentation website, without hardcoded version URLs - improve formatting of "Getting Involved" section to make it more readable - simplify the roadmap, removing things already achieved, and summarising to 5 steps - move the Contributing section to the end - website: remove previous workaround to "hard code" docusaurus urls to the latest version, meaning we can use unversioned links in the readme
rikoe
force-pushed
the
feat/streamline-main-readme
branch
from
779e9dd to
fcff145
Compare
mattjamieson
requested changes
Jan 27, 2021
| pnpm install @finos/fdc3 | ||
| ``` | ||
|
|
||
| Note that the web application still needs to run in the context of an FDC3 desktop agent to work. For more details, please see the [relevant documentation](https://fdc3.finos.org/docs/installation). |
There was a problem hiding this comment.
@mattjamieson that link still has to be added! There is nothing about installing the npm package right now...
- fix fdc3 mailto link
- update copyright
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This change updates and simplifies the main repository README for FDC3. This serves two purposes:
As part of this PR, I have simplified the initial description of FDC3, with an emphasis on the four specifications that form part of the standard. I then show a short usage example, followed by a link to the FDC3 website for more info.
I have shortened and simplified the roadmap, and tried to bring it in line with our current goals. (It previously took up a lot of unnecessary space in the README.)
I have also taken out any documentation links that led to hardcoded version URLs (e.g. version "1.0" or "1.1") - links will now take you to whatever the latest published version is.
Example (see the entire updated file in my fork):
Full list of changes: