diff --git a/LOCALIZATION.md b/LOCALIZATION.md deleted file mode 100644 index 6ce57498e9..0000000000 --- a/LOCALIZATION.md +++ /dev/null @@ -1,77 +0,0 @@ -# Docs Localization - -## Introduction - -Welcome to the [NEAR Dev Docs](https://docs.near.org/) translation project. -This article is aimed to community members that want to help in the localization of NEAR's documentation. -If you feel comfortable translating from English into your local language, you're more than welcome to contribute with this project. - -### Roles - -For simplicity, the translation project is hosted on [Crowdin](https://crowdin.com/project/near-docs) and anyone is free to register and join. -There are 3 basic roles across the Crowdin project: - -1. **Translator:** translates documentation -2. **Proof Reader:** helps proof reading localized documents -3. **Manager:** manages memberships and helps with technical issues - - -### How to become a Translator - -To become a certified NEAR docs translator, you need to pass a pre-translation test by working on a selected document translation. A proof reader will review your document, and if your translation proves to be high-quality, your application will be accepted and you'll be accepted as a NEAR Certified Translator. - -> To become a certified translator, please join our [Crowdin project](https://crowdin.com/project/near-docs) and [create a new topic](https://crowdin.com/project/near-docs/discussions) with your application. -> The NEAR team will review your request, assign a test, and follow up with you as needed. -> -> If you have questions, please contact us on [Discord](https://near.chat). - -## How to translate - -Before you start working on the translation of an article, you need to get pre-approval from the community first. The reason is to make sure the plans are transparent in the community, and the proof-readers can help to review and approve the translation once it's ready. - -You can check the current translation plans available for each language on the [Tasks section](https://crowdin.com/project/near-docs/tasks): - -![image](website/static/docs/assets/crowdin-tasks.png) - -If there's no active plan for your language, you can submit a proposal by opening a thread on the [Discussions section](https://crowdin.com/project/near-docs/discussions). -Once your plan is pre-approved by the community, you can just go to the [Crowdin project](https://crwd.in/near-docs) and work on the translation of the specific markdown file. - -### Translation plan - -For each language, the current plan is to translate all the documents with the following priorities. - -**Website** - -1. `website` (except the `docusaurus-plugin-content-blog` folder) - - -**Developer** - -1. `concepts` -2. `build` -3. `tutorials` -4. `tools` -5. `api` -6. `integrations` - - -**Exchanges & Integration** - -1. `roles` -2. `faq` - -![image](website/static/docs/assets/crowdin-list.png) - -### Proof reading and go-to Production - -For each document, expect no less than two proof readers to review the translations. The translator or proof reader can propose different translations if he/she doesn't agree the existing ones, the translations that receive the most votes will be accepted and displayed in the production version. - -> Please pay attention to the maintainer's feedback, since its a necessary step to keep up with the standards NEAR attains to. - -## Questions? - -If you have any questions feel free to post them to our [Discord channel](http://near.chat). - -Thanks for your time and translations! - -> Got a question? [Ask it on StackOverflow!](https://stackoverflow.com/questions/tagged/nearprotocol) diff --git a/README.md b/README.md index f773f24d09..443615c872 100644 --- a/README.md +++ b/README.md @@ -11,13 +11,13 @@ ## NEAR Protocol - scalable and usable blockchain [![Discord](https://img.shields.io/discord/490367152054992913.svg)](http://near.chat) -[![CI](https://github.com/near/docs/actions/workflows/build-docs.yml/badge.svg)](https://github.com/near/docs/actions/workflows/build-docs.yml) +[![CI](https://github.com/near/docs/actions/workflows/build-check.yml/badge.svg)](https://github.com/near/docs/actions/workflows/build-check.yml) This is the repository for the official documentation of NEAR Protocol, a user-friendly and carbon-neutral blockchain, built from the ground up to be performant, secure, and infinitely scalable. ## Quick start -Check out the following links +Check out the following links: - Deployed, live documentation: https://docs.near.org - Example applications: https://github.com/near-examples @@ -27,7 +27,7 @@ Check out the following links NEAR uses [Docusaurus](https://docusaurus.io) for documentation. Please refer to their documentation for details on major structural contributions to the documentation. -For simple content changes you have 2 options +For simple content changes you have 2 options: - [Submit an issue](https://github.com/near/docs/issues) - [Submit a pull request](https://github.com/near/docs/pulls) *(we prefer PRs of course)* @@ -43,7 +43,7 @@ This is the fastest way to submit content changes directly from the page where y ### The typical PR -This is the standard fork-branch-commit workflow for submitting pull requests to open source repositories +This is the standard fork-branch-commit workflow for submitting pull requests to open-source repositories: 1. Fork this repo to your own GitHub account (or just clone it directly if you are currently a member of NEAR) diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index dd8a7392f7..6f799a7814 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -184,7 +184,7 @@ const config = { }, { type: 'html', - value: '
Support ', + value: '
Support
', }, { href: 'https://discord.gg/GZ7735Xjce', @@ -196,7 +196,7 @@ const config = { }, { type: 'html', - value: '
Education ', + value: '
Education
', }, { href: 'https://agorapp.dev/catalog/course?difficulty=&chains=near', @@ -208,7 +208,7 @@ const config = { }, { type: 'html', - value: '
Other Docs ', + value: '
Other Docs
', }, { href: 'https://github.com/near/NEPs',