Skip to content

Commit

Permalink
Docs - Build Tab (#703)
Browse files Browse the repository at this point in the history
* fix nginx config.

* Docs - Build Tab

* Moving things around

* moving some more things around

* moving more things around

* messing with tokens

* moving and shuffling some files around

* moving some more things from the most recent `main` commits

* add a TODO about re-setting broken links configs

* shifting around token things

* update token interface to v20.5.0

* Adjustments

* start on fixing the broken linkies

* link extravaganza

* links

* links

* content updates

* content updates and formatting

* homepage

* redirects

* fix some broken links in asset issuing tutorial

* fix learn URL on index page

* moving and shuffling build/token redirects

* rename dapp frontend filename

* adjusting/tweaking some older redirects

* links

* add a couple more redirect changes

* specify the next/prev pagination items since we moved create frontend

* /docs content

* Moving assets and tokens

* links

* use mdx links in docs/README.mdx

* misc fixes in stellar.toml info page

* remove unnecessary heading in tokens quickstart page

* shuffle and reorg sidebar declarations (no affect on actual docs)

* expand smart contracts section in build sidebar

* add some frontmatter config to docs/README.mdx

* re-adding redirects that were overwritten

---------

Co-authored-by: overcat <[email protected]>
Co-authored-by: Elliot Voris <[email protected]>
  • Loading branch information
3 people authored Jul 2, 2024
1 parent 6d57f4e commit 3b903a4
Show file tree
Hide file tree
Showing 203 changed files with 561 additions and 502 deletions.
36 changes: 23 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,23 @@ If you're here for the Deep Dive Docs Bounty, please navigate to the bottom of t

- [Contributing](#contributing)
- [Quick Start](#quick-start)
- [Prerequisites](#prerequisites)
- [Development](#development)
- [Repository Structure](#repository-structure)
- [Using Markdown](#using-markdown)
- [Markdown Basics](#markdown-basics)
- [Custom Markdown](#custom-markdown)
- [Alert](#alert)
- [Code Example](#code-example)
- [Deep Dive Docs Bounty](#welcome-to-the-deep-dive-docs-bounty-)
- [Welcome to the Deep Dive Docs Bounty 🐙!](#welcome-to-the-deep-dive-docs-bounty-)
- [Submission process](#submission-process)
- [What makes a good submission](#what-makes-a-good-submission)
- [Helpful resources](#helpful-resources)
- [Deep Dive Docs Bounty Eligibility Guidelines](#deep-dive-docs-bounty-eligibility-guidelines)
- [Submission Guidelines](#submission-guidelines)
- [Award Eligibility Guidelines](#award-eligibility-guidelines)
- [License to Submissions](#license-to-submissions)
- [Legal Terms and Acknowledgements](#legal-terms-and-acknowledgements)

## Contributing

Expand Down Expand Up @@ -42,7 +52,7 @@ No matter what you contribute, whether a PR or an issue, you can expect to recei

- PRs need to be reviewed and approved before merging. Look for either an approval or a follow-up question.
- Issues will be prioritized, labeled, and assigned (if possible). You can check the status of your issue on the Dev Docs board. The status of issues according to the column is:
- Ideas: these issues are being actively discussed. Ideas will either be discarded or repurposed into an actionable issue and added to the queue within three weeks.
- Ideas: these issues are being actively discussed. Ideas will either be discarded or repurposed into an actionable issue and added to the queue within three weeks.
- Backlog: these issues are not prioritized or actively being worked on.
- To Do: these issues are prioritized and will be worked on soon.
- In Progress: these issues are currently being worked on.
Expand Down Expand Up @@ -249,61 +259,61 @@ If you haven't already, check out the [Stellar docs](https://developers.stellar.
- Comment and tag `briwylde08` on the issue you'd like to work on and she will mark your chosen issue as “In Progress” in the Projects - Status section and assign you to the issue
- When you’re ready, open a [pull request (PR)](https://github.com/stellar/stellar-docs/pulls) in the Stellar Developer Docs GitHub and link to the corresponding issue in the PR description
- When you’ve completed your work on the PR, comment on the PR tagging `briwylde08` to let her know the PR is ready for review
- Bri will respond to your PR within three days of it being submitted and will mark the corresponding issue as “In Review”
- Bri will respond to your PR within three days of it being submitted and will mark the corresponding issue as “In Review”

We will review your submission within three weeks and reply on your submission thread to let you know if your submission qualifies to earn an award! If so, we will ask you to complete a form to collect the info necessary to validate and deliver an award.

If your submission did not qualify, we may provide you with feedback on what's missing or on how you can improve your submission so it qualifies. Once you have made the requested revisions, we will re-review your submission and let you know if your updated submission qualifies for an award.
If your submission did not qualify, we may provide you with feedback on what's missing or on how you can improve your submission so it qualifies. Once you have made the requested revisions, we will re-review your submission and let you know if your updated submission qualifies for an award.

### What makes a good submission

The Stellar Development Foundation (“SDF”) will review submissions as they come in, and all Deep Dive Docs Bounty awards are contingent upon the review and approval of the submission by SDF at its sole discretion.

Your submission should adequately solve its corresponding issue. Each issue will include the amount of XLM it’s worth based on its complexity and say, “Get up to $__ worth of XLM for this issue.” Exact awards are then based on the quality of the submission (is it well-written, well-crafted, and easy to follow?) and thoroughness (is it comprehensive and well-documented?).

Here are some existing guides to help you get an idea of what we’re looking for:
Here are some existing guides to help you get an idea of what we’re looking for:

- [Build a Payment App with the JS SDK](https://developers.stellar.org/docs/building-apps/example-application-tutorial/payment): Payment Tutorial: something like this guide would get the full award allocation because it provides an introduction that defines how payments work, information about the user experience, and a detailed code walkthrough.
- [Deploy a Contract from Installed Wasm Bytecode How-To Guide](https://developers.stellar.org/docs/smart-contracts/guides/cli/deploy-contract): something like this would be eligible for a lower award amount because it only provides the code implementation without any explanatory material.
- [Deploy a Contract from Installed Wasm Bytecode How-To Guide](https://developers.stellar.org/docs/build/guides/cli/deploy-contract): something like this would be eligible for a lower award amount because it only provides the code implementation without any explanatory material.

**Note:** SDF is under no obligation to make any awards if there are no eligible submissions or Eligible Individuals (as defined below) or if Eligible Individuals do not successfully complete the compliance and tax obligations set forth below.

## Helpful resources

Here are some resources that may be helpful to get you started:

- [Existing smart contract How-To Guides](https://developers.stellar.org/docs/smart-contracts/guides): many open issues involve creating new How-To Guides, so check out our existing guides in the docs to get a feel for the format and the content.
- [Stellar Developer Discord](https://discord.gg/stellardev): if you’re stuck on an issue, the Stellar Developer Discord is a great place to get guidance from the ecosystem.
- [Existing smart contract How-To Guides](https://developers.stellar.org/docs/build/guides): many open issues involve creating new How-To Guides, so check out our existing guides in the docs to get a feel for the format and the content.
- [Stellar Developer Discord](https://discord.gg/stellardev): if you’re stuck on an issue, the Stellar Developer Discord is a great place to get guidance from the ecosystem.

## Deep Dive Docs Bounty Eligibility Guidelines

### Submission Guidelines
- All submission materials should be in English or, if not in English, include an English translation.
- All submission materials should be in English or, if not in English, include an English translation.
- Do not submit:
- Submissions that point to ongoing asset sales, ICOs, referral programs, or affiliate links.
- Speculative submissions, price or price prediction submissions, or “why X should buy Y” articles.
- Submissions attacking others. Please adhere to the SDF Code of Conduct.
- Other people’s work - no plagiarizing or infringing on a third party’s rights.
- All submissions must be original works, and the author should own all rights, title, and interest in the submission. If third-party licensed content is included in a submission, all necessary rights must be fully sub-licensable to SDF. Submissions should not include any content that is unlawful, breaches any third-party rights, or is otherwise in violation of or contrary to applicable laws or regulations.
- All submissions must be original works, and the author should own all rights, title, and interest in the submission. If third-party licensed content is included in a submission, all necessary rights must be fully sub-licensable to SDF. Submissions should not include any content that is unlawful, breaches any third-party rights, or is otherwise in violation of or contrary to applicable laws or regulations.

### Award Eligibility Guidelines

While anyone may make a submission, only Eligible Individuals will be considered for XLM awards. For purposes of Deep Dive Docs Bounty, an “Eligible Individual'' is a natural person who:

1. Is 18 years of age or older;
2. Is not an individual on the U.S. Department of Treasury’s Office of Foreign Assets Control (OFAC) Specially Designated Nationals and Blocked Persons List or otherwise under sanction by OFAC (or an immediate family member - spouses, parent, child, sibling, grandparent, and “step” child - of such individual) or be employed by or affiliated with an entity sanctioned by OFAC;
2. Is not an individual on the U.S. Department of Treasury’s Office of Foreign Assets Control (OFAC) Specially Designated Nationals and Blocked Persons List or otherwise under sanction by OFAC (or an immediate family member - spouses, parent, child, sibling, grandparent, and “step” child - of such individual) or be employed by or affiliated with an entity sanctioned by OFAC;
3. Is not a resident of any country, state, province or territory subject to comprehensive OFAC sanctions, including Cuba, Iran, North Korea, Syria or any Russian-controlled region of Ukraine; and
4. Does not reside in a jurisdiction where the transfer and holding of cryptocurrency is illegal or would require a special license or authorization that the such person does not possess.

SDF reserves the right, in its absolute discretion, to disqualify any participant or submission, without warning, from Deep Dive Docs Bounty, and to ban them from future programs funded by the Soroban adoption fund if they act in a way that violates these guidelines, is inappropriate, or not in the best interests or spirit of the program.

### License to Submissions

By posting a submission, you will be granting to SDF and its assigns, licensees, and successors a royalty-free, irrevocable, non-exclusive and unlimited right and permission to use your submission, name, picture, statements, project name, likeness, and voice, and any material based thereon or derived therefrom (collectively, the “Content”), in any form, media, or technology now known or later developed, and to use, edit, modify, duplicate, distribute, publish, publicize and/or create derivative works from the Content (or any portion thereof), throughout the world, in perpetuity, without limitation and without payment of any royalties or compensation, consideration, notice or permission, except where prohibited by law, for the purpose of creating educational, informational, and promotional materials or creative assets (any such materials or assets that feature the Content are referred to herein as “Assets”), including, without limitation, on social media, or on any website owned or affiliated with SDF. You will have no right of approval, no claim to any compensation, and no claim arising out of the use, alteration, or distortion or use in any composite form of the Content.
By posting a submission, you will be granting to SDF and its assigns, licensees, and successors a royalty-free, irrevocable, non-exclusive and unlimited right and permission to use your submission, name, picture, statements, project name, likeness, and voice, and any material based thereon or derived therefrom (collectively, the “Content”), in any form, media, or technology now known or later developed, and to use, edit, modify, duplicate, distribute, publish, publicize and/or create derivative works from the Content (or any portion thereof), throughout the world, in perpetuity, without limitation and without payment of any royalties or compensation, consideration, notice or permission, except where prohibited by law, for the purpose of creating educational, informational, and promotional materials or creative assets (any such materials or assets that feature the Content are referred to herein as “Assets”), including, without limitation, on social media, or on any website owned or affiliated with SDF. You will have no right of approval, no claim to any compensation, and no claim arising out of the use, alteration, or distortion or use in any composite form of the Content.

### Legal Terms and Acknowledgements

Deep Dive Docs Bounty is governed by the [SDF Terms of Service](https://www.stellar.org/terms-of-service?locale=en) and the guidelines described herein (the “Deep Dive Docs Bounty Eligibility Guidelines”). SDF may collect personal information from you in connection with your submission, and such information is subject to the [SDF Privacy Policy](https://www.stellar.org/privacy-policy?locale=en). SDF reserves the right, in its sole discretion, to cancel, suspend and/or modify all or any part of Deep Dive Docs Bounty at any time for any reason. The terms and conditions of Deep Dive Docs Bounty are subject to change at any time, including the rights or obligations of the Participants and SDF.
Deep Dive Docs Bounty is governed by the [SDF Terms of Service](https://www.stellar.org/terms-of-service?locale=en) and the guidelines described herein (the “Deep Dive Docs Bounty Eligibility Guidelines”). SDF may collect personal information from you in connection with your submission, and such information is subject to the [SDF Privacy Policy](https://www.stellar.org/privacy-policy?locale=en). SDF reserves the right, in its sole discretion, to cancel, suspend and/or modify all or any part of Deep Dive Docs Bounty at any time for any reason. The terms and conditions of Deep Dive Docs Bounty are subject to change at any time, including the rights or obligations of the Participants and SDF.

XLM is a highly risky and volatile asset, and SDF does not provide any representations, warranties, or guarantees of its value. You will be required to provide certain information to facilitate receipt of any XLM award, including completing and submitting any tax or other forms necessary for compliance with applicable withholding and reporting requirements. You are responsible for reporting the receipt of any XLM award to relevant government departments or agencies, where applicable, and paying all applicable taxes in your jurisdiction of residence. SDF reserves the right to withhold a portion of any award amount to comply with the tax laws of the United States or other relevant jurisdictions. You should inform yourself as to any legal and tax requirements or consequences applicable to you in respect of the acquisition, holding, and disposition of XLM. You are also responsible for complying with any applicable foreign exchange and banking regulations relating to any XLM award received hereunder.

Expand Down
99 changes: 17 additions & 82 deletions docs/README.mdx
Original file line number Diff line number Diff line change
@@ -1,100 +1,35 @@
---
title: Introduction
sidebar_position: 0
title: Stellar Developer Docs
displayed_sidebar: build
hide_table_of_contents: true
---

import { CodeExample } from "@site/src/components/CodeExample";
## Navigating the docs

This section walks you through building on Stellar without smart contracts. Learn basic Stellar functions such as creating accounts and making payments, how to issue assets on the network, how to build an application with the JavaScript SDK, Wallet SDK, and more.
### [Build](/docs/build/README.mdx)

## Fast Track
Contains tutorials and how-to guides for writing smart contracts, building applications, interacting with the network, and more.

Issue your first asset on the Stellar network in **one, single transaction**!
### [Learn](/docs/learn/fundamentals/README.mdx)

<CodeExample>
Find all informational and conceptual content here. Learn about Stellar fundamentals like how accounts and transactions function, dive deeper into the functionality of each operation, discover how fees work, and more.

```js
const {
Keypair,
Horizon,
TransactionBuilder,
Networks,
Operation,
Asset,
BASE_FEE,
} = require("@stellar/stellar-sdk");
### [Tokens](/docs/tokens/README.mdx)

// Don't forget to fund these accounts, somehow. Have you met Friendbot?
// https://developers.stellar.org/docs/tutorials/create-account#create-account
const issuerKeypair = Keypair.random();
const destinationKeypair = Keypair.random();
Information on how to issue assets on the Stellar network and create custom smart contract tokens.

const server = new Horizon.Server("https://horizon-testnet.stellar.org");
const account = await server.loadAccount(issuerKeypair.publicKey());
const abcAsset = new Asset("ABC", issuerKeypair.publicKey());
### [Data](/docs/data/README.mdx)

const transaction = new TransactionBuilder(account, {
fee: BASE_FEE,
networkPassphrase: Networks.TESTNET,
})
.addOperation(
Operation.changeTrust({
asset: abcAsset,
source: destinationKeypair,
}),
)
.addOperation(
Operation.payment({
destination: destinationKeypair.publicKey(),
asset: abcAsset,
amount: "100",
}),
)
.setTimeout(30)
.build();
Discover various data availability options: RPC, Hubble, and Horizon.

transaction.sign(issuerKeypair, destinationKeypair);
const res = await server.submitTransaction(transaction);
console.log(`Transaction response: ${res}`);
```
### [Tools](/docs/tools/README.mdx)

```python
from stellar_sdk import Asset, Keypair, Network, Server, TransactionBuilder
Learn about all the available tools at your disposal for building on, interacting with, or just watching the Stellar network. Also, find information on how to use the Anchor Platform or Stellar Disbursement Platform.

## Don't forget to fund these accounts, somehow. Have you met Friendbot?
## https://developers.stellar.org/docs/tutorials/create-account#create-account
issuer_keypair = Keypair.random()
destination_keypair = Keypair.random()
### [Reference](/docs/reference/networks.mdx)

server = Server('https://horizon-testnet.stellar.org')
account = server.load_account(issuer_keypair.public_key)
abc_asset = Asset('ABC', issuer_keypair.public_key)
A quick look at useful information such as the various network data (for Mainnet, Testnet, and Futurenet), current software versions, and resource limitations and fees.

transaction = (
TransactionBuilder(
source_account=account,
network_passphrase=Network.TESTNET_NETWORK_PASSPHRASE,
base_fee=100,
)
.append_change_trust_op(
asset=abc_asset,
source=destination_keypair.public_key,
)
.append_payment_op(
destination=destination_keypair.public_key,
amount='100',
asset=abc_asset,
)
.set_timeout(30)
.build()
)
### [Validators](/docs/validators/README.mdx)

transaction.sign(issuer_keypair)
transaction.sign(destination_keypair)

res = server.submit_transaction(transaction)
print(f"Transaction response: {res}")
```

</CodeExample>
Everything you'll need to know if you want to run, operate, and maintain a core validator node on the Stellar network.
7 changes: 0 additions & 7 deletions docs/anchoring-assets/_category_.json

This file was deleted.

Loading

0 comments on commit 3b903a4

Please sign in to comment.