-
Notifications
You must be signed in to change notification settings - Fork 191
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
20 changed files
with
535 additions
and
309 deletions.
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
# Translation Initiative | ||
|
||
_Our translation initiative hopes to translate Scroll documentation into different languages and make the website accessible to people worldwide._ | ||
|
||
Our current documentation is only available in English, but with community contributions, we want to support many language communities. Since this is a new initiative and we want to maintain high assurances about the information in our documentation, **we're only accepting contributions in Mandarin and Spanish**. Once we're comfortable with the process and can ensure a good experience for community translators, we'll seek contributions in additional languages. | ||
|
||
### Want to get involved as a translator? | ||
|
||
Create an issue describing which article you wish to translate. Then get started! If you need help or have any questions, join the [Scroll Discord](https://discord.gg/scroll). Once your translation is submitted, we'll ask a member of our team to do a review. | ||
|
||
### Standards and Policies | ||
|
||
For now, we will defer to Ethereum.org's excellent [Translation Style Guide](https://ethereum.org/en/contributing/translation-program/translators-guide/). We do not use a translation platform, but please assume all other guidance applies here. | ||
|
||
## Starting a translation | ||
|
||
1. Fork this repository | ||
1. Create an issue named using the format "Translation: _[English Article Name]_ (_[lang]_)" -- for example, "Translation: User Guide Faucet (zh)" | ||
1. Find the article you wish to translate in `src/content/docs/en/` and copy it to a matching folder in `src/content/docs/[lang]/`. All files should maintain the same file name and folder structure as the English version of the site. | ||
1. To translate UI elements or article names, modify the appropriate entry in `public/locales/[lang]/translation.json`. If you're unsure what to do here, suggest any additional changes to the site in your PR. | ||
1. Make a PR with the title following the template above. Be sure to mention the original issue in your description. | ||
1. A team member will review, recommend changes and work with you to get the final version added to the code base. | ||
|
||
### Not familiar with Git? | ||
|
||
If you don't want to worry about all this Git stuff, contact a team member or community moderator on the [Scroll Discord](https://discord.gg/scroll). We'd be happy to point you at the original file to translate and suggest an online text editor (like [HackMD](https://hackmd.io/)) for sharing your results. We'll take it from there. |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
{ | ||
"notTranslated": { | ||
"notTranslated": "Esta página aún no ha sido traducida." | ||
} | ||
} |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,138 @@ | ||
--- | ||
section: gettingStarted | ||
title: "Article Components" | ||
date: Last Modified | ||
lang: "en" | ||
permalink: "/article-components" | ||
excerpt: "Learn more about the topics of Ethereum Scalability and Zero Knowledge Cryptography" | ||
isMdx: true | ||
whatsnext: { "Next Up Page 1": "/", "Second Next Up Page": "/" } | ||
metadata: | ||
title: "Conceptual Overview" | ||
description: "Metadata for social media and search results." | ||
image: | ||
0: "/files/ToDo:-image-file-name.png" | ||
--- | ||
|
||
import ClickToZoom from "../../../components/ClickToZoom.astro" | ||
import priceAggr from "../../../assets/images/contract-devs/price-aggr.png" | ||
import ToggleElement from "../../../components/ToggleElement.astro" | ||
import Aside from "../../../components/Aside.astro" | ||
|
||
This is body text right under the article title. It typically is just paragraph text that's pretty straightforward. Then there's **bold text**, and _italic text_, and **_bold-italic text_**, and `inline-code` and **`bold inline code`** and even _`italic inline code`_ and **_`bold italic inline code`_**. And of course don't forget [links](#), and [**bold links**](#), and [_italic links_](#), and [**_bold-italic links_**](#). | ||
|
||
## Markdown Components (also an H2 Heading) | ||
|
||
- We've also got unordered lists! | ||
- They can have multiple items. | ||
- And some sub-items. | ||
- That get into details | ||
- That's an unordered list. | ||
|
||
What else do we have? | ||
|
||
1. Of course there's also ordered lists. | ||
1. They look like this. | ||
1. They're pretty useful. | ||
|
||
### H3 Heading | ||
|
||
#### H4 Heading | ||
|
||
##### H5 Heading | ||
|
||
Let's see a horizontal rule. | ||
|
||
--- | ||
|
||
We define the Square-Fibonacci sequence[^1], a variation of the Fibonacci sequence: | ||
|
||
### Math | ||
|
||
- Let $f_0 = 1, f_1 = 1$ | ||
- For $$i \geq 2$$, define $f_{i} := (f_{i-2})^2 + (f_{i-1})^2 \mod q$ | ||
- Where $q$ is a large prime integer. We use this modulus to bound the size of each element, so that it can be represented by some predetermined number of bits. | ||
|
||
### Tables | ||
|
||
| Syntax | Description | | ||
| --------- | ----------- | | ||
| Header | Title | | ||
| Paragraph | Text | | ||
|
||
### Blockquotes | ||
|
||
> #### Success | ||
> | ||
> Vitae reprehenderit at aliquid error voluptates eum dignissimos. | ||
### Footnotes | ||
|
||
Here's a simple footnote,[^1] and here's a longer one.[^bignote] | ||
|
||
[^1]: This is the first footnote. | ||
[^bignote]: Here's one with multiple paragraphs and code. | ||
|
||
### Callout that worked in MD, but might not in MDX? | ||
|
||
:::tip[Did you know?] | ||
Astro helps you build faster websites with “Islands Architecture”. | ||
::: | ||
|
||
## Imported MDX Components | ||
|
||
### Callouts | ||
|
||
<Aside type="note" title="note"> | ||
{" "} | ||
Astro helps you build faster websites with “Islands Architecture”.{" "} | ||
</Aside> | ||
<Aside type="caution" title="caution"> | ||
{" "} | ||
Astro helps you build faster websites with “Islands Architecture”.{" "} | ||
</Aside> | ||
<Aside type="danger" title="danger"> | ||
{" "} | ||
Astro helps you build faster websites with “Islands Architecture”.{" "} | ||
</Aside> | ||
|
||
<Aside type="tip" title="tip"> | ||
For .md file you can use this code. | ||
</Aside> | ||
|
||
``` | ||
:::tip[Did you know?] | ||
Astro helps you build faster websites with “Islands Architecture”. | ||
::: | ||
``` | ||
|
||
### Images zoom | ||
|
||
<ClickToZoom src={priceAggr} /> | ||
|
||
### Toggle | ||
|
||
<ToggleElement anchor="Why build on Scroll?"> | ||
<div slot="title">Why build on Scroll?</div> | ||
<p> | ||
Scroll enables creators to turn their content into interactive, explorable experiences. With Scroll, you can create | ||
rich, interactive stories that engage readers, provide a better user experience, and help you stand out from the | ||
crowd. | ||
</p> | ||
</ToggleElement> | ||
<ToggleElement anchor="How does Scroll work?"> | ||
<div slot="title">How does Scroll work?</div> | ||
<p> | ||
Scroll combines powerful technologies like WebGL and WebRTC to create immersive, interactive experiences. The | ||
platform allows you to build 3D environments, add interactivity, and embed content from popular web services to | ||
create a unique, engaging experience for your audience. | ||
</p> | ||
</ToggleElement> | ||
<ToggleElement anchor="What can I build with Scroll?"> | ||
<div slot="title">What can I build with Scroll?</div> | ||
<p> | ||
You can build a wide range of experiences with Scroll, from interactive articles to immersive product demos and | ||
virtual tours. Scroll is designed to help you create engaging, interactive experiences that elevate your content and | ||
captivate your audience. | ||
</p> | ||
</ToggleElement> |
Oops, something went wrong.