Skip to content

Commit

Permalink
feat: move contribute
Browse files Browse the repository at this point in the history
  • Loading branch information
a-bahdanau committed Oct 22, 2024
1 parent d5d213c commit 56bec6b
Show file tree
Hide file tree
Showing 25 changed files with 134 additions and 60 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ If you are a developer and faced some difficulties, successfully overcoming them
— 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)
Contributing best practices: [docs/contribute](https://ton.org/docs/v3/contribute)

---

Expand Down
2 changes: 1 addition & 1 deletion docs/develop/dapps/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ Interested in decentralized finance (DeFi)? Here's how to handle different types
Missing some crucial material? You can either write a tutorial yourself or describe the problem for the community.


<Button href="/contribute/participate" colorType="primary" sizeType={'sm'}>
<Button href="/v3/contribute/participate" colorType="primary" sizeType={'sm'}>

Contribute

Expand Down
2 changes: 1 addition & 1 deletion docs/develop/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Welcome to the official TON Blockchain development documentation!

This resource aims to provide you with all the necessary information you'll need to build, test, and deploy applications on the TON Blockchain.

This is a collaborative open-source initiative, and contributions are always welcome. All documentation can be edited via GitHub, just [follow these instructions](/contribute).
This is a collaborative open-source initiative, and contributions are always welcome. All documentation can be edited via GitHub, just [follow these instructions](/v3/contribute).

- _TON Hello World_ series provides detailed step-by-step guides to wallets, smart contracts, mini apps, and testing & debugging smart contracts on TON.
- _Get Started with TON_ is a step-by-step guide to interacting with TON Blockchain. (video tutorial included)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ Displays various statistics such as number of registered network addresses and w

## Want to be in this list?

Please, write to one of the [maintainers](/docs/contribute/maintainers.md).
Please, write to one of the [maintainers](/docs/v3/contribute/maintainers.md).

## References

Expand Down
2 changes: 1 addition & 1 deletion docs/contribute/README.md → docs/v3/contribute/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ There are several ways to identify the area where you can contribute to TON Docs

- Join [TON Docs Club chat](https://t.me/+c-0fVO4XHQsyOWM8) in Telegram and get the latest tasks from maintainers.
- If you have a specific contribution in mind but are unsure about it, confirm whether
the contribution is appropriate by contacting one of the [Docs maintainers](/contribute/maintainers) directly.
the contribution is appropriate by contacting one of the [Docs maintainers](/v3/contribute/maintainers) directly.
- Get familiar with the most frequently asked questions in the [TON Developers](https://t.me/tondev_eng) chats.
- Please read over the [issues](https://github.com/ton-community/ton-docs/issues) in the GitHub repository.
- Learn available [footsteps](https://github.com/ton-society/ton-footsteps/issues?q=documentation) for the documentation.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@ Every page in TON documentation should be finished with See Also section. Place
:::info
```
## See Also
* [TON Contribution Guidelines](/contribute/contribution-rules)
* [Tutorial Styling Guidelines](/contribute/tutorials/guidelines)
* [TON Contribution Guidelines](/v3/contribute/contribution-rules)
* [Tutorial Styling Guidelines](/v3/contribute/tutorials/guidelines)
```
:::

Expand All @@ -40,5 +40,5 @@ The TON Ecosystem is being built for the entire world, so it's crucial that it's

## See Also

* [TON Contribution Guidelines](/contribute/contribution-rules)
* [Tutorial Styling Guidelines](/contribute/tutorials/guidelines)
* [TON Contribution Guidelines](/v3/contribute/contribution-rules)
* [Tutorial Styling Guidelines](/v3/contribute/tutorials/guidelines)
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The **TownSquare Labs Localization Program** is open to everyone! Here are a few

1. Log in to your [**Crowdin**](https://crowdin.com) account or sign up.
2. Select the language you want to contribute to.
3. Familiarize yourself with the [**How to Use Crowdin**](/contribute/localization-program/how-to-contribute) guide and the [**Translation Style Guide**](/contribute/localization-program/translation-style-guide) for tips and best practices.
3. Familiarize yourself with the [**How to Use Crowdin**](/v3/contribute/localization-program/how-to-contribute) guide and the [**Translation Style Guide**](/v3/contribute/localization-program/translation-style-guide) for tips and best practices.
4. Use machine translations to aid your work but do not rely solely on them.
5. All translation results can be previewed on the website one hour after they have been proofread.

Expand Down Expand Up @@ -127,4 +127,4 @@ Currently, we have all desired languages in Crowdin. If you are a community mana
Once these steps are completed, you can see the preview of your language in the PR request.
![ko preview](/img/localizationProgramGuideline/ko_preview.png)

When your language is ready for the TON docs, create an issue, and we'll set your language into the production environment.
When your language is ready for the TON docs, create an issue, and we'll set your language into the production environment.
Original file line number Diff line number Diff line change
Expand Up @@ -31,5 +31,5 @@ We are highly thankful to the thousands of community members who are the key par

## Guides and Resources
If you are contributing to the Translation Program or considering getting involved, please check out the translation guides below:
* [**Translation Style Guide**](/contribute/localization-program/translation-style-guide) – Instructions and tips for translators.
* [**Crowdin Online Editor Guide**](https://support.crowdin.com/online-editor/) – An in-depth guide to using the Crowdin online editor and some of Crowdin's advanced features.
* [**Translation Style Guide**](/v3/contribute/localization-program/translation-style-guide) – Instructions and tips for translators.
* [**Crowdin Online Editor Guide**](https://support.crowdin.com/online-editor/) – An in-depth guide to using the Crowdin online editor and some of Crowdin's advanced features.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ Write a _ton-footstep_ to receive a funding for your contributing.
## Writing a tutorial

**Preparations**. Minimize future amount of requested changes, _save your time_:
1. Follow [Tutorial Guidelines](/contribute/guidelines) and check them with [Sample Tutorial Structure](/contribute/sample-tutorial)
2. Read [Principles of a Good Tutorial](/contribute/principles-of-a-good-tutorial) to write amazing tutorial :)
1. Follow [Tutorial Guidelines](/v3/contribute/guidelines) and check them with [Sample Tutorial Structure](/v3/contribute/sample-tutorial)
2. Read [Principles of a Good Tutorial](/v3/contribute/principles-of-a-good-tutorial) to write amazing tutorial :)
3. Inspire with [Mint your first Jetton](/v3/guidelines/dapps/tutorials/mint-your-first-token) example in sources.
4. **Setup environment**. [Check the tutorial](/contribute#online-one-click-contribution-setup) running your fork locally or using Gitpod.
5. **Write tutorial**. Using the environment, see how tutorial looks like on your fork.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,15 +12,15 @@ It is important that you take some time to become familiar with the tutorial str
Before you start writing, *read the guidelines below*! They will help you ensure the level of standardization and quality that will make the review process much faster.
:::

Also, be sure to refer to the [**sample tutorial structure**](/contribute/tutorials/sample-tutorial) we have provided.
Also, be sure to refer to the [**sample tutorial structure**](/v3/contribute/tutorials/sample-tutorial) we have provided.


1. To begin, fork and then clone the [ton-docs](https://github.com/ton-community/ton-docs/) repository on GitHub and create a new branch in your local repository.
2. Write your tutorial keeping quality and readability in mind! Have a look at the existing tutorials to see what you should aim for.
3. When you're ready to submit it for review, [open a Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) from your branch. We will be notified, and the review process will begin:
1. **Please make every effort to submit only the final draft of your tutorial**. Some typos and grammar fixes are acceptable, but if there are significant changes to be made before we can publish the tutorial, it will take much longer to review and have you make the necessary changes.
4. Once we've reviewed your submission and you've made all necessary changes, we'll merge the Pull Request and publish the tutorial on TON Documentation. We'll contact you shortly after this to arrange your payment!
5. Once it is published, remember to **promote** your tutorial on social media! The [documentation maintainers](/contribute/maintainers) can help to amplify this promotion as long as you cooperate with us.
5. Once it is published, remember to **promote** your tutorial on social media! The [documentation maintainers](/v3/contribute/maintainers) can help to amplify this promotion as long as you cooperate with us.

To summarize, the workflow is as follows:
1. ***Fork and Clone*** the **`ton-docs`** repository
Expand Down Expand Up @@ -58,7 +58,7 @@ Regarding other word combinations like "TON + noun" (e.g., "the TON world," "the
## How to structure your tutorial

:::info Sample tutorial structure
Feel free to check out the [sample tutorial structure](/contribute/tutorials/sample-tutorial) to see it with your own eyes.
Feel free to check out the [sample tutorial structure](/v3/contribute/tutorials/sample-tutorial) to see it with your own eyes.
:::

- The **Title** should be direct and clear, summarizing the tutorial's goal. Do not add the tutorial title as a heading inside the document; instead, use the markdown document filename.
Expand All @@ -81,7 +81,7 @@ Feel free to check out the [sample tutorial structure](/contribute/tutorials/sam
- _For example_: "We have successfully deployed our contract."
- When providing direct instructions, feel free to use “you”, “your”, etc.
- _For example_: “*Your file should look like this:*”.
- **Use Markdown properly** throughout your tutorial. Refer to [GitHub's markdown guide](https://guides.github.com/features/mastering-markdown/) as well as the [sample tutorial structure](/contribute/tutorials/sample-tutorial).
- **Use Markdown properly** throughout your tutorial. Refer to [GitHub's markdown guide](https://guides.github.com/features/mastering-markdown/) as well as the [sample tutorial structure](/v3/contribute/tutorials/sample-tutorial).
- **Do not use pre-formatted text for emphasis**, *for example*:
- ❌ "TON counter `smart contract` named `counter.fc`" is incorrect.
- ✅ "TON counter **smart contract** named `counter.fc`" is correct.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,15 +49,15 @@ You have plenty of time to participate in the event. Let's build decentralized I



<Button href="/contribute/hacktoberfest/as-contributor"
<Button href="/v3/contribute/hacktoberfest/as-contributor"
colorType="primary" sizeType={'lg'}>

I want to become a Contributor

</Button>


<Button href="/contribute/hacktoberfest/as-maintainer" colorType={'secondary'} sizeType={'lg'}>
<Button href="/v3/contribute/hacktoberfest/as-maintainer" colorType={'secondary'} sizeType={'lg'}>

I'm a Maintainer

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ To become a contributor who receives a limited *Hack-TON-berfest NFT*, please se
2. Please provide your wallet address to the [@toncontests_bot](https://t.me/toncontests_bot) in Telegram.
3. Validate your GitHub account in the same bot.

After these steps you are ready to contribute and receive a [limited Hack-TON-berfest NFT](/contribute/hacktoberfest/#what-the-rewards).
After these steps you are ready to contribute and receive a [limited Hack-TON-berfest NFT](/v3/contribute/hacktoberfest/#what-the-rewards).

Welcome to the club, this is just the beginning!

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ After that, feel free to add your repository to the list.
As a repository maintainer in the TON Ecosystem, you will be able to receive two types of rewards:

1. [Hacktoberfest Reward Kit](https://hacktoberfest.com/participation/#maintainers) (_see REWARD FOR MAINTAINERS_)
2. [Limited Hack-TON-berfest NFT](/contribute/hacktoberfest/#what-the-rewards) (_please, register the wallet address in the [@toncontests_bot](https://t.me/toncontests_bot)_)
2. [Limited Hack-TON-berfest NFT](/v3/contribute/hacktoberfest/#what-the-rewards) (_please, register the wallet address in the [@toncontests_bot](https://t.me/toncontests_bot)_)

## How to join and be listed?

Expand Down
4 changes: 2 additions & 2 deletions navbar.js
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ module.exports = {
],
},
{
to: 'contribute',
to: 'v3/contribute',
position: 'right',
className: 'header-contribute-link',
'aria-label': 'Contribute',
Expand All @@ -260,7 +260,7 @@ module.exports = {
value: '<hr style="margin: 0.3rem 0;">',
},
{
href: "/contribute/localization-program/overview",
href: "/v3/contribute/localization-program/overview",
label: 'Help Us Translate',
},
],
Expand Down
82 changes: 81 additions & 1 deletion redirects/redirects.json
Original file line number Diff line number Diff line change
Expand Up @@ -742,5 +742,85 @@
{
"from": "/develop/smart-contracts/environment/installation",
"to": "/v3/documentation/archive/precompiled-binaries"
},
{
"from": "/contribute/archive/hacktoberfest-2022",
"to": "/v3/documentation/archive/hacktoberfest-2022"
},
{
"from": "/contribute/archive/hacktoberfest-2022/README",
"to": "/v3/documentation/archive/hacktoberfest-2022/README"
},
{
"from": "/contribute/archive/hacktoberfest-2022/as-contributor",
"to": "/v3/documentation/archive/hacktoberfest-2022/as-contributor"
},
{
"from": "/contribute/archive/hacktoberfest-2022/as-maintainer",
"to": "/v3/documentation/archive/hacktoberfest-2022/as-maintainer"
},
{
"from": "/contribute/docs",
"to": "/v3/contribute/docs"
},
{
"from": "/contribute/docs/guidelines",
"to": "/v3/contribute/docs/guidelines"
},
{
"from": "/contribute/docs/schemes-guidelines",
"to": "/v3/contribute/docs/schemes-guidelines"
},
{
"from": "/contribute/localization-program",
"to": "/v3/contribute/localization-program"
},
{
"from": "/contribute/localization-program/translation-style-guide",
"to": "/v3/contribute/localization-program/translation-style-guide"
},
{
"from": "/contribute/localization-program/how-to-contribute",
"to": "/v3/contribute/localization-program/how-to-contribute"
},
{
"from": "/contribute/localization-program/overview",
"to": "/v3/contribute/localization-program/overview"
},
{
"from": "/contribute/localization-program/how-it-works",
"to": "/v3/contribute/localization-program/how-it-works"
},
{
"from": "/contribute/tutorials",
"to": "/v3/contribute/tutorials"
},
{
"from": "/contribute/tutorials/sample-tutorial",
"to": "/v3/contribute/tutorials/sample-tutorial"
},
{
"from": "/contribute/tutorials/principles-of-a-good-tutorial",
"to": "/v3/contribute/tutorials/principles-of-a-good-tutorial"
},
{
"from": "/contribute/tutorials/guidelines",
"to": "/v3/contribute/tutorials/guidelines"
},
{
"from": "/contribute/contribution-rules",
"to": "/v3/contribute/contribution-rules"
},
{
"from": "/contribute/maintainers",
"to": "/v3/contribute/maintainers"
},
{
"from": "/contribute/participate",
"to": "/v3/contribute/participate"
},
{
"from": "/contribute",
"to": "/v3/contribute"
}
]
]
2 changes: 1 addition & 1 deletion sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
learn: require('./sidebars/concepts'),
develop: require('./sidebars/develop'),
develop: require('./sidebars/documentation'),
guidelines: require('./sidebars/guidelines'),
contribute: require('./sidebars/contribute'),
};
Expand Down
41 changes: 13 additions & 28 deletions sidebars/contribute.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,46 +2,31 @@
* @type {import('@docusaurus/plugin-content-docs').SidebarConfig}
*/
module.exports = [
'contribute/README',
'v3/contribute/README',
{
'type': 'category',
'label': 'Common Rules',
'items': [
'contribute/contribution-rules',
'contribute/participate',
'contribute/maintainers',
'v3/contribute/contribution-rules',
'v3/contribute/participate',
'v3/contribute/maintainers',
],
},
{
'type': 'category',
'label': 'Documentation',
'items': [
'contribute/docs/guidelines',
'contribute/docs/schemes-guidelines',
'v3/contribute/docs/guidelines',
'v3/contribute/docs/schemes-guidelines',
],
},
{
'type': 'category',
'label': 'Tutorials',
'items': [
'contribute/tutorials/guidelines',
'contribute/tutorials/principles-of-a-good-tutorial',
'contribute/tutorials/sample-tutorial',
],
},
{
'type': 'category',
'label': 'Archive',
'items': [
{
'type': 'category',
'label': 'Hacktoberfest 2022',
'items': [
'contribute/archive/hacktoberfest-2022/README',
'contribute/archive/hacktoberfest-2022/as-contributor',
'contribute/archive/hacktoberfest-2022/as-maintainer',
],
},
'v3/contribute/tutorials/guidelines',
'v3/contribute/tutorials/principles-of-a-good-tutorial',
'v3/contribute/tutorials/sample-tutorial',
],
},
{
Expand All @@ -51,22 +36,22 @@ module.exports = [
{
type: 'doc',
label: 'Overview',
id: 'contribute/localization-program/overview',
id: 'v3/contribute/localization-program/overview',
},
{
type: 'doc',
label: 'How It Works',
id: 'contribute/localization-program/how-it-works',
id: 'v3/contribute/localization-program/how-it-works',
},
{
type: 'doc',
label: 'How To Contribute',
id: 'contribute/localization-program/how-to-contribute',
id: 'v3/contribute/localization-program/how-to-contribute',
},
{
type: 'doc',
label: 'Translation Style Guide',
id: 'contribute/localization-program/translation-style-guide',
id: 'v3/contribute/localization-program/translation-style-guide',
},
],
},
Expand Down
19 changes: 14 additions & 5 deletions sidebars/develop.js → sidebars/documentation.js
Original file line number Diff line number Diff line change
Expand Up @@ -364,12 +364,21 @@ module.exports = [
keywords: ['archive'],
},
items: [
'v3/documentation/archive/compilepow-givers',
'v3/documentation/archive/compilemining',
'v3/documentation/archive/compiletg-bot-integration',
'v3/documentation/archive/compiletg-bot-integration-py',
'v3/documentation/archive/compileREADME',
'v3/documentation/archive/pow-givers',
'v3/documentation/archive/mining',
'v3/documentation/archive/tg-bot-integration',
'v3/documentation/archive/tg-bot-integration-py',
'v3/documentation/archive/compile',
'v3/documentation/archive/precompiled-binaries',
{
'type': 'category',
'label': 'Hacktoberfest 2022',
'items': [
'v3/documentation/archive/hacktoberfest-2022/README',
'v3/documentation/archive/hacktoberfest-2022/as-contributor',
'v3/documentation/archive/hacktoberfest-2022/as-maintainer',
],
},
]
}
];

0 comments on commit 56bec6b

Please sign in to comment.