Skip to content
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
fix some typos and grammar
quickfixes
  • Loading branch information
dankoman30 committed Aug 24, 2021
commit ef5c2e394d5c358ada14545e09fb1e0ce9164bef
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ community include:
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
* Focusing on what is best, not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:
Expand Down
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Discussions are also the place to talk about your ideas on how to improve the po

Make yourself familiar with the [Project Structure](https://developers.cardano.org/docs/portal-contribute/#project-structure).

We try to keep everything as simple as possible, but not simpler. If you see something that could be improved you are encouraged to raise an issue wherein you propose your changes and explain the rationale.
We try to keep everything as simple as possible, but not simpler. If you see something that could be improved, you are encouraged to raise an issue wherein you propose your changes and explain the rationale.

## Project Showcase

Expand All @@ -30,7 +30,7 @@ Read the **requirements** and follow the **instructions** in the header of the [

#### A word about project descriptions

Descriptions help users find a project they are interested in and decide whether to visit the links you provided. Use relevant keywords and describe what your project is all about or that it does. Don't include claims in your description like *the **best** wallet*, *the **first** ABC* or *the **only** XYZ*. We will ask you to change the description in your pull request before merging. @TODO rationale?
Descriptions help users find a project they are interested in and decide whether to visit the links you provided. Use relevant keywords and describe what your project is all about or what it does. Don't include claims in your description like *the **best** wallet*, *the **first** ABC* or *the **only** XYZ*. We will ask you to change the description in your pull request before merging. @TODO rationale?

## Builder Tools

Expand All @@ -42,7 +42,7 @@ Read the **requirements** and follow the **instructions** in the header of the [

## Pull Requests

To maintain the quality of content on the developer portal we use pull requests to integrate changes from contributors.
To maintain the quality of content on the developer portal, we use pull requests to integrate changes from contributors.

Please follow these steps to have your contribution considered by the maintainers:

Expand Down
4 changes: 2 additions & 2 deletions docs/fund-your-project/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ image: ./img/og-developer-portal.png

![Fund your project](../../static/img/card-fund-your-project-title.svg)

Cardano was already designed with sustainability in mind. The point was to create a system that governs and also finance itself without being dependent on donations. Cardano has a built-in treasury system that gets a constant stream of funds from transactions fees and treasury taxes. This is explained in detail in [treasuries with Bingsheng Zhang](https://www.youtube.com/watch?v=Hyh3h_yX-S0).
Cardano was already designed with sustainability in mind. The point was to create a system that governs and also finances itself without being dependent on donations. Cardano has a built-in treasury system that gets a constant stream of funds from transaction fees and treasury taxes. This is explained in detail in [treasuries with Bingsheng Zhang](https://www.youtube.com/watch?v=Hyh3h_yX-S0).

## Project Catalyst

[Project Catalyst](project-catalyst), Cardano's innovation platform, is the current way to access the funds of the treasury system. It is seen as a stepping stone to Voltaire and aims to provide a safe and lively environment to explore the highest potential of human collaboration.
[Project Catalyst](project-catalyst), Cardano's innovation platform is the current way to access the funds of the treasury system. It is seen as a stepping stone to Voltaire and aims to provide a safe and lively environment to explore the highest potential of human collaboration.
2 changes: 1 addition & 1 deletion docs/fund-your-project/project-catalyst.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Built around ‘Active Campaigns’, the Project Catalyst Ideascale contains sev

Within each active campaign, you can find a campaign brief. This is a short explainer of what proposals should include, how to meet the campaign's requirements and some guiding questions for proposals. You will also find a stage flow that guides you through the timeline of each campaign.

If you click on ‘Browse Ideas’, you can see a [list of other proposals](https://cardano.ideascale.com/a/ideas/recent/campaign-filter/byids/campaigns/25873/stage/unspecified) that community members have already created. If you’re thinking of submitting a proposal, this is a great way to see what goes into a successful proposal and how you can position your proposal for maximum traction. For voters and community participants, this is also where you can join discussions or upvote your favourite proposal.
If you click on ‘Browse Ideas’, you can see a [list of other proposals](https://cardano.ideascale.com/a/ideas/recent/campaign-filter/byids/campaigns/25873/stage/unspecified) that community members have already created. If you’re thinking of submitting a one, this is a great way to see what goes into a successful proposal and how you can position your proposal for maximum traction. For voters and community participants, this is also where you can join discussions or upvote your favourite proposal.

:::tip Catalyst Announcements
The best way to keep up to date with Project Catalyst is to follow [the announcement channel on Telegram](https://t.me/cardanocatalyst).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -117,4 +117,4 @@ const transaction = CardanoWasm.Transaction.new(

## A note on fees

Fees is Cardano Shelley are based directly on the size of the final encoded transaction. It is important to note that a transaction created by this library potentially can vary in size compared to one built with other tools. This is because transactions, as well as other Cardano Shelley structures, are encoded using [CBOR](https://cbor.io/) a binary JSON-like encoding. Due to arrays and maps allowing both definite or indefinite length encoding in the encoded transaction created by the library, the size can vary. This is because definite encoding consists of a tag containing the size of the array/map which can be 1 or more bytes long depending on the number of elements the size of the encoded structure, while indefinite length encoding consists of a 1 byte starting tag and after all elements are listed, a 1 byte ending tag. These variances should should only be a couple bytes and cardano-serialization-lib uses definite encoding which is the same length or smaller for any reasonable sized transaction.
Fees in Cardano Shelley are based directly on the size of the final encoded transaction. It is important to note that a transaction created by this library potentially can vary in size compared to one built with other tools. This is because transactions, as well as other Cardano Shelley structures, are encoded using [CBOR](https://cbor.io/) a binary JSON-like encoding. Due to arrays and maps allowing both definite or indefinite length encoding in the encoded transaction created by the library, the size can vary. This is because definite encoding consists of a tag containing the size of the array/map which can be 1 or more bytes long depending on the number of elements the size of the encoded structure, while indefinite length encoding consists of a 1 byte starting tag and after all elements are listed, a 1 byte ending tag. These variances should should only be a couple bytes and cardano-serialization-lib uses definite encoding which is the same length or smaller for any reasonable sized transaction.
2 changes: 1 addition & 1 deletion docs/get-started/cardano-serialization-lib/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ library from any common programming language (even C and WebAssembly)!
Serialization/deserialization code is automatically generated from
Cardano’s official specification, which guarantees it can easily stay up
to date! We do this using an EMURGO-written tool called [cddl-codegen](https://github.com/Emurgo/cddl-codegen)
which can be re-used for other tasks such as automatically generate a
which can be re-used for other tasks such as automatically generating a
Rust library for Cardano metadata specifications!

It is also very easy to create scripts in Rust or WASM to share with
Expand Down
10 changes: 5 additions & 5 deletions docs/portal-contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ We wanted to build an open and inclusive, easy to use developer portal that offe

## Installation

To contribute to the Cardano developer portal you must first install it locally.
To contribute to the Cardano developer portal, you must first install it locally.

### Requirements

Expand All @@ -20,7 +20,7 @@ To contribute to the Cardano developer portal you must first install it locally.

### Local development

To get a local development environment clone the repository, navigate into the `developer-portal` folder, install dependencies and start the development server. Most changes are reflected live without having to restart the server. By default, a browser window will open at `http://localhost:3000`.
To get a local development environment, clone the repository, navigate into the `developer-portal` folder, install dependencies, and start the development server. Most changes are reflected live without having to restart the server. By default, a browser window will open at `http://localhost:3000`.

```sh
git clone https://github.com/cardano-foundation/developer-portal.git
Expand All @@ -30,7 +30,7 @@ yarn start
```

:::info Limitations of the development build
The development mode will have minor features not working. Like for example, only blurry images in the responsive images on showcase and tools, search limitations, and some data has fake values because of performance reasons.
The development mode will have minor features not working. For example, only blurry images in the responsive images on showcase and tools, search limitations, and some data has fake values because of performance reasons.
:::

### Production build
Expand All @@ -39,7 +39,7 @@ The development mode will have minor features not working. Like for example, onl
yarn build
```

Use this command instead of `yarn start` to generate static content into the build directory that can be served using any static contents hosting service.
Use this command instead of `yarn start` to generate static content into the build directory that can be served using any static content hosting service.

## Project structure

Expand Down Expand Up @@ -99,7 +99,7 @@ developer-portal
- `/blog/` - Contains the blog Markdown files for the developer spotlight.
- `/docs/` - Contains the Markdown files for the docs. Customize the order of the docs sidebar in `sidebars.js`.
- `/examples/` - Contains example projects for the Markdown files in the docs. *The structure is not final and will likely change in the future*
- `/src/` - Non-documentation files like pages or custom React components. You don't have to strictly put your non-documentation files in here but putting them under a centralized directory makes it easier to specify in case you need to do some sort of linting/processing.
- `/src/` - Non-documentation files like pages or custom React components. You don't have to strictly put your non-documentation files in here, but putting them under a centralized directory makes it easier to specify in case you need to do some sort of linting/processing.
- `/src/data/builder-tools` - Screenshots for the builder tools section.
- `/src/data/builder-tools.js` - Definition file for the builder tools section.
- `/src/data/showcase` - Screenshots for the showcase section.
Expand Down
14 changes: 7 additions & 7 deletions docs/portal-style-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You can write content using [GitHub-flavored Markdown syntax](https://github.git

## Markdown Examples

This page will help you learn about the Markdown used in the Cardano Developer Portal, but the list is not intended to be exhaustive. Read the [docusaurus markdown features](https://docusaurus.io/docs/next/markdown-features) for more examples.
This page will help you learn about the Markdown used in the Cardano Developer Portal, but the list is not intended to be exhaustive. Read the [docusaurus Markdown features](https://docusaurus.io/docs/next/markdown-features) for more examples.

Let's start with the basics:

Expand Down Expand Up @@ -165,7 +165,7 @@ Inline-style: ![alt text](../static/img/logo-plutus-small.png 'This is the Plutu
Reference-style: ![alt text][logo]
[logo]: https://raw.githubusercontent.com/adam-p/markdown-here/master/src/common/images/icon48.png 'This is a logo reference-style'

Images from any folder can be used by providing path to file. Path should be relative to markdown file:
Images from any folder can be used by providing path to file. Path should be relative to Markdown file:
![alt text](../static/img/logo-plutus.png)
```

Expand All @@ -175,7 +175,7 @@ Inline-style: ![alt text](../static/img/logo-plutus-small.png 'This is the Plutu
Reference-style: ![alt text][logo]
[logo]: https://raw.githubusercontent.com/adam-p/markdown-here/master/src/common/images/icon48.png 'This is a logo reference-style'

Images from any folder can be used by providing path to file. Path should be relative to markdown file:
Images from any folder can be used by providing path to file. Path should be relative to Markdown file:
![alt text](../static/img/logo-plutus.png)

</TabItem>
Expand Down Expand Up @@ -220,7 +220,7 @@ Images from any folder can be used by providing path to file. Path should be rel

## Code

In the developer portal you will often have to display code. You can display code with different syntax highlighting:
In the developer portal, you will often have to display code. You can display code with different syntax highlighting:
<Tabs
defaultValue="js"
values={[
Expand Down Expand Up @@ -361,7 +361,7 @@ function HelloCodeTitle(props) {

## Tabs

You can use tabs for example to display code examples in different languages:
You can use tabs to display code examples in different languages. For example:

```html
import Tabs from '@theme/Tabs';
Expand Down Expand Up @@ -712,13 +712,13 @@ Please try to avoid other style elements, and always keep in mind that people wi

Last but not least, let's talk about editors, extensions and configurations.

You can use any text editor you like to write markdown. [Visual Studio Code](https://code.visualstudio.com/), [Sublime](https://www.sublimetext.com/), [Atom](https://atom.io/), etc. have plugins that help you adhere to style guides by displaying warnings if you break the rules.
You can use any text editor you like to write Markdown. [Visual Studio Code](https://code.visualstudio.com/), [Sublime](https://www.sublimetext.com/), [Atom](https://atom.io/), etc. have plugins that help you adhere to style guides by displaying warnings if you break the rules.

Below are some extensions for these editors that help you write clean guides for the developer portal.

### markdownlint

Adds syntax highligting for markdown files and display configurable warnings for invalid formatting.
Adds syntax highligting for Markdown files and display configurable warnings for invalid formatting.

<Tabs
defaultValue="vscode"
Expand Down