diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000000..1a5e6270ea --- /dev/null +++ b/.editorconfig @@ -0,0 +1,8 @@ +# EditorConfig is awesome: https://EditorConfig.org + +# top-most EditorConfig file +root = true + +[*] +indent_style = space +indent_size = 2 \ No newline at end of file diff --git a/.eslintignore b/.eslintignore new file mode 100644 index 0000000000..50823300f7 --- /dev/null +++ b/.eslintignore @@ -0,0 +1,3 @@ +./.docusaurus +./build +./node_modules \ No newline at end of file diff --git a/.eslintrc.js b/.eslintrc.js new file mode 100644 index 0000000000..5e90d0b2c3 --- /dev/null +++ b/.eslintrc.js @@ -0,0 +1,15 @@ +// .eslintrc.js example +module.exports = { + env: { + browser: true, + es2021: true + }, + parser: "@typescript-eslint/parser", + parserOptions: { + ecmaVersion: "latest", + sourceType: "module" + }, + rules: { + indent: ["error", 2] + } +} \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index dff602072d..3b34b5e300 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -1,6 +1,6 @@ -name: Feature request +name: Docs feature request description: Suggest an idea for this project -title: Feature request +title: Docs feature request labels: ["feature :sparkles:"] body: - type: textarea @@ -17,22 +17,8 @@ body: description: A clear and concise description of what you want to happen validations: required: true - - type: textarea - id: feature_request_alternatives - attributes: - label: Describe alternatives you've considered - description: A clear and concise description of any alternative solutions or features you've considered - validations: - required: true - type: textarea id: feature_request_additional_context attributes: label: Additional context description: Add any other context or screenshots about the feature request here - - type: markdown - attributes: - value: | - **Want to contribute?** - - type: markdown - attributes: - value: We love contributions from the TON community! Please comment on an issue if you're interested in helping out with a PR. diff --git a/.github/labeler.yml b/.github/labeler.yml index 91ec2cea3a..3bbdd60914 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -8,7 +8,7 @@ - i18n/**/* "documentation :book:": - - README.md + - academy-overview.md "tooling :wrench:": - .github/**/* diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml new file mode 100644 index 0000000000..31fe41d0ec --- /dev/null +++ b/.github/workflows/lint.yml @@ -0,0 +1,19 @@ +name: Lint + +on: pull_request + +jobs: + eslint: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-node@v3 + with: + node-version: 16 + - run: npm ci # or yarn install + - uses: sibiraj-s/action-eslint@v3 + with: + token: ${{ secrets.GITHUB_TOKEN }} # optional + ignore-path: .eslintignore + extensions: 'js,jsx,ts,tsx' + annotations: true \ No newline at end of file diff --git a/.gitignore b/.gitignore index 8b0ed8b4f4..12d3096dfd 100644 --- a/.gitignore +++ b/.gitignore @@ -24,3 +24,5 @@ npm-debug.log* yarn-debug.log* yarn-error.log* .gitpod.yml + +.env \ No newline at end of file diff --git a/README.md b/README.md index ee41774527..48429b25d2 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ This is the official repository for The Open Network documentation. Latest documentation release: [docs.ton.org](https://docs.ton.org) - + The mission of this documentation is to collect all available information and knowledge that can help TON developers. You can improve the documentation by following steps below. @@ -21,7 +21,7 @@ TON is an actively growing ecosystem, and every day many devs contribute to its You can participate in TON by helping organize knowledge, making Pull Requests and creating tutorials to help other developers. Feedback, lectures, technical articles, tutorials, and examples. All this can help the developers community grow even faster! -Join TON Docs Club chat in Telegram and get the latest tasks from maintainers: +Join TON Docs Club chat in Telegram to join contributors party: * https://t.me/+c-0fVO4XHQsyOWM8 --- @@ -30,12 +30,11 @@ Join TON Docs Club chat in Telegram and get the latest tasks from maintainers: ## How to Contribute? 🦄 -As said before, it's up to you. - If you are a developer and faced some difficulties, successfully overcoming them - share this knowledge with future developers! -— Have an idea? [Submit an issue](https://github.com/ton-community/ton-docs/issues/new/choose). -— Want to validate changes? [Setup your environment](https://github.com/ton-community/ton-docs#set-up-your-environment-%EF%B8%8F). +— Have an issue? [Prepare a solution with TON Docs Wizard](https://t.me/ton_docs_bot). +— Have an idea? [Submit a Feature Request](https://github.com/ton-community/ton-docs/issues/new/choose). +— Want to contribute? [Setup your environment](https://github.com/ton-community/ton-docs#set-up-your-environment-%EF%B8%8F). Contributing best practices: [docs/contribute](https://ton.org/docs/contribute) @@ -68,9 +67,25 @@ Use Gitpod (a free, online VS code-like IDE) for contributing. It will launch a ``` npm run start ``` +6. Build with multiple locales and run it locally + + ``` + npm run build + npm run serve + ``` This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. +## Contributors Wall + + + + +

+ + ↑ Back to Top ↑ + +

## License [GPL-3.0](https://choosealicense.com/licenses/gpl-3.0/) diff --git a/crowdin.yml b/crowdin.yml new file mode 100644 index 0000000000..103b36bfb6 --- /dev/null +++ b/crowdin.yml @@ -0,0 +1,12 @@ +project_id: '663652' +api_token_env: CROWDIN_PERSONAL_TOKEN +preserve_hierarchy: 1 +files: + - source: /i18n/en/**/* + translation: /i18n/%two_letters_code%/**/%original_file_name% + - source: /docs/**/* + translation: /i18n/%two_letters_code%/docusaurus-plugin-content-docs/current/**/%original_file_name% + ignore: + - /docs/**/*.png + - source: /src/pages/learn/**/* + translation: /i18n/%two_letters_code%/docusaurus-plugin-content-pages/learn/**/%original_file_name% diff --git a/deployment/Docker/nginx.conf b/deployment/Docker/nginx.conf index 3f76f13270..cde1b8753b 100644 --- a/deployment/Docker/nginx.conf +++ b/deployment/Docker/nginx.conf @@ -2,7 +2,7 @@ server { server_name _; location / { - root /app; + root /app; try_files $uri $uri/index.html $uri.html 404.html; } } diff --git a/docs/contribute/archive/hacktoberfest-2022/README.mdx b/docs/contribute/archive/hacktoberfest-2022/README.mdx index a27f44972a..f9f5d47662 100644 --- a/docs/contribute/archive/hacktoberfest-2022/README.mdx +++ b/docs/contribute/archive/hacktoberfest-2022/README.mdx @@ -1,13 +1,13 @@ import Button from '@site/src/components/button' # What is Hacktoberfest? - +````mdx-code-block
tlb structure
- +```` [Hacktoberfest](https://hacktoberfest.digitalocean.com/) is a month-long celebration of *open-source projects*, their *maintainers*, and the entire community of *contributors*. Each October, open source maintainers give new contributors extra attention as they guide developers through their first pull requests. For the TON Community it's time to help ecosystem growth together, so let's join the whole world with our **Hack-TON-berfest** party and become *#1 open-source ecosystem of the year*! @@ -30,14 +30,16 @@ For everyone in TON it's an opportunity to drive the growth of the entire ecosys ## What are the rewards? To motivate the community to contribute to open source projects in the TON Ecosystem, you'll be able to receive a special reward from TON Foundation. Every participant will receive a **Limited Hack-TON-berfest NFT** achievement as a proof of participating: - -
-