Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Soroban Merge] Create a "Platforms" section #325

Merged
merged 147 commits into from
Mar 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
147 commits
Select commit Hold shift + click to select a range
1ceb9e9
API documentation for Soroban-RPC (#253)
ElliotFriend Jan 24, 2023
7c6aa80
Clarify encoding of hash in the api docs (#282)
Jan 25, 2023
d4b9664
Providing an example for retrieving contract code using `getLedgerEnt…
ElliotFriend Jan 25, 2023
835a539
update all admonitions such that prettier doesn't yell
kalepail Feb 3, 2023
00f65df
Reorg (#290)
kalepail Feb 7, 2023
74503c6
Update documentation to reflect recent getEvents changes (#293)
tamirms Feb 11, 2023
c3360df
Merge dev docs to main (#316)
dmkozh Feb 15, 2023
d1c3a55
Update documentation for getTransaction() and sendTransaction() (#336)
tamirms Mar 2, 2023
3db384d
Clean up page descriptions in category indexes (#348)
brson Mar 23, 2023
824e364
Add new diagnostic filter type to getEvents method (#349)
2opremio Mar 24, 2023
eb14f9a
Update getEvents documentation to include event type csv (#353)
tamirms Mar 28, 2023
1e941b2
Add `events` response field to simulateTransaction method (#354)
2opremio Mar 29, 2023
b6bb6d9
Merge pull request #319 from paulbellamy/dev
paulbellamy Feb 16, 2023
db27ead
Remove out of date file
sisuresh Apr 5, 2023
3246d90
Remove the deprecated (and now removed) getAccount soroban-rpc method
Apr 6, 2023
124bea5
Merge pull request #366 from stellar/remove-soroban-rpc-get-account
paulbellamy Apr 6, 2023
e93aec0
Updated docs for getLatestLedger
stellarsaur Apr 6, 2023
265d55a
Update return obj descriptions
stellarsaur Apr 6, 2023
3d82df6
Merge pull request #370 from stellar/get-latest-ledger-docs
stellarsaur Apr 6, 2023
016e383
API: Update simulateTransaction RPC method to include fee support (#439)
2opremio May 22, 2023
39ee3ad
Update API method documentation (#445)
2opremio May 24, 2023
e671a56
Update API method documentation (#445)
2opremio May 24, 2023
523d061
API: fix parameter description in getLedgerEntries (#457)
2opremio May 25, 2023
391b638
API: fix parameter description in getLedgerEntries (#457)
2opremio May 25, 2023
42c26b6
Update getLedgerEntries docs. (#472)
overcat Jun 9, 2023
153e902
Update getLedgerEntries docs. (#472)
overcat Jun 9, 2023
36f01c4
Release Preview 10 (#480)
leighmcculloch Jul 13, 2023
dced5e8
Release Preview 10 (#480)
leighmcculloch Jul 13, 2023
c4cf33c
Clarify that there is always 0 or 1 item in `results` (#506)
Shaptic Jul 21, 2023
970427a
Add javascript example to get the WASM content (#473)
vinamogit Jul 24, 2023
66e0050
Add javascript example to get the WASM content (#473)
vinamogit Jul 24, 2023
9a57b17
Update soroban-rpc docs (#551)
2opremio Aug 22, 2023
2b5580d
Update simulateTransaction.mdx (#567)
2opremio Sep 19, 2023
4dd36ef
feat: Display example RPC requests as a useable CURL command (#568)
ElliotFriend Sep 19, 2023
796da1f
feat: Display example RPC requests as a useable CURL command (#568)
ElliotFriend Sep 19, 2023
d21d197
Update Futurenet to Testnet Across Documentation (#577)
Julian-dev28 Sep 22, 2023
ce2e3ff
Update Futurenet to Testnet Across Documentation (#577)
Julian-dev28 Sep 22, 2023
0717be8
Clarify that IDs are strkeys, plus minor lang cleanup (#605)
Shaptic Oct 10, 2023
d366f06
update getLedgerEntries documentation (#614)
tsachiherman Oct 16, 2023
0401f00
update getLedgerEntries documentation (#614)
tsachiherman Oct 16, 2023
3726c89
Reworked documentation of Soroban RPC methods using open-rpc-docs-rea…
MazurakIhor Oct 18, 2023
d516799
Reworked documentation of Soroban RPC methods using open-rpc-docs-rea…
MazurakIhor Oct 18, 2023
f75442c
rpc: rename expirationLedgerSeq to liveUntilLedgerSeq (#625)
2opremio Oct 26, 2023
2e0eb8c
rpc: rename expirationLedgerSeq to liveUntilLedgerSeq (#625)
2opremio Oct 26, 2023
7b5f59c
Update WASM retrieval tutorial (#627)
Shaptic Oct 26, 2023
ca42372
Update WASM retrieval tutorial (#627)
Shaptic Oct 26, 2023
b32d484
Upgrade `getLedgerEntries` examples to latest pre-stable releases of …
Shaptic Nov 2, 2023
5d46973
Upgrade `getLedgerEntries` examples to latest pre-stable releases of …
Shaptic Nov 2, 2023
03a4a26
Integrate a complete `openrpc.json` document (#647)
ElliotFriend Nov 20, 2023
6a27a9f
Integrate a complete `openrpc.json` document (#647)
ElliotFriend Nov 20, 2023
4c5c05a
Fix openrpc playground urls (#649)
ElliotFriend Nov 20, 2023
9201fac
synchronize api example tabs across pages (#661)
ElliotFriend Nov 29, 2023
4ea110b
State archival refactor (#678)
SirTyson Dec 11, 2023
a09c145
Add v20.0.0 (#668)
Julian-dev28 Dec 18, 2023
1f6badc
soroban-docs: Update simulateTransaction Docs With New resourceConfig…
stellarsaur Dec 21, 2023
3e61b01
Update JavaScript SDK references to use the `@stellar/stellar-sdk` pa…
Shaptic Dec 22, 2023
b601ff0
Update JavaScript SDK references to use the `@stellar/stellar-sdk` pa…
Shaptic Dec 22, 2023
b2353fa
Update the state archival JavaScript tutorial (#698)
Shaptic Jan 3, 2024
aa6b0e6
Update the state archival JavaScript tutorial (#698)
Shaptic Jan 3, 2024
b68d1f0
api: add new diagnosticEventsXdr field in sendTransaction response (#…
2opremio Jan 9, 2024
855b579
Pre mainnet restructure (#644)
ElliotFriend Jan 9, 2024
78dbe30
Pre mainnet restructure (#644)
ElliotFriend Jan 9, 2024
4517d84
Generate the `openrpc.json` specification file in this repo (#692)
ElliotFriend Jan 10, 2024
afd88d4
Update RPC docs for clarify on deprecation of postional array and cos…
janewang Feb 15, 2024
286a979
Fix case of parameter (#727)
leighmcculloch Feb 16, 2024
da8c3f0
use by-name params in pagination example (#743)
ElliotFriend Feb 22, 2024
d71f64d
create platforms section of docs
ElliotFriend Feb 28, 2024
0951d82
modify sidebars
ElliotFriend Feb 28, 2024
26d8a98
rename sidebar generator for api/platforms docs
ElliotFriend Feb 28, 2024
a19d398
re-order admin guides for the various platforms
ElliotFriend Feb 28, 2024
41169ea
fix broken links
ElliotFriend Feb 28, 2024
2e03e35
custom css for dropdown "sections" in the platforms navbar item
ElliotFriend Feb 28, 2024
605be36
change `/api` -> `/platforms` in custom sidebar component
ElliotFriend Feb 28, 2024
5aa86a4
docusaurus config changes
ElliotFriend Feb 28, 2024
e5e0445
fix typo in sdp filepath
ElliotFriend Feb 28, 2024
5559d83
fix more broken links
ElliotFriend Feb 28, 2024
a841081
change rpc filepath to reflect "platforms" language
ElliotFriend Feb 28, 2024
d76b7e3
Merge remote-tracking branch 'rpcSubset/main' into soroban-merge/rpc
ElliotFriend Feb 28, 2024
0127f54
fix broken links and setup soroban-rpc sidebar
ElliotFriend Feb 28, 2024
5f946de
install required packages for soroban rpc methods
ElliotFriend Feb 28, 2024
b019f5c
modify custom RpcMethod component to handle a single rpc doc
ElliotFriend Feb 28, 2024
f7407f1
specify `platform=soroban` for these methods
ElliotFriend Feb 28, 2024
eca8e27
add soroban-rpc to Platforms dropdown menu
ElliotFriend Feb 28, 2024
94a43f9
remove sdp from the docs sidebar, since it is now in platforms
ElliotFriend Feb 28, 2024
3474335
Merge pull request #1 from ElliotFriend/soroban-merge/rpc
ElliotFriend Feb 28, 2024
226aa4e
custom css for metmask openrpc package
ElliotFriend Feb 28, 2024
d8977a9
fix a broken link
ElliotFriend Feb 28, 2024
f8b613b
update URLs in openrpc specfile
ElliotFriend Feb 28, 2024
eb65636
rename admin guide directories
ElliotFriend Feb 28, 2024
896f362
use the default layout for admin guide pages
ElliotFriend Feb 28, 2024
476ffcb
fix some broken links
ElliotFriend Feb 28, 2024
672c13a
Add Hubble to Platforms tab
briwylde08 Feb 28, 2024
9382f51
display admin guide docs with default DocItem component
ElliotFriend Feb 28, 2024
448b5b1
Merge branch 'soroban-merge/platforms' of github.com:ElliotFriend/ste…
ElliotFriend Feb 28, 2024
14f2cdb
specify the slug for the hubble overview page
ElliotFriend Feb 28, 2024
f5df5cc
include hubble pages in the default DocItem component check
ElliotFriend Feb 28, 2024
1901510
remove unnecessary console statement
ElliotFriend Feb 28, 2024
10cb1ea
fix broken links
ElliotFriend Feb 28, 2024
33d2066
Merge branch 'main' of github.com:stellar/stellar-docs into soroban-m…
ElliotFriend Feb 28, 2024
b90d779
move soroban rpc intro files into a consisten folder
ElliotFriend Feb 28, 2024
8805a14
move new anchor platform events docs into place
ElliotFriend Feb 28, 2024
f1377f9
fix broken links
ElliotFriend Feb 28, 2024
c193d57
improve text in platforms index page
ElliotFriend Feb 28, 2024
62b9520
Merge branch 'main' into soroban-merge/platforms
ElliotFriend Feb 28, 2024
6d59369
Add Introduction to Horizon
briwylde08 Feb 28, 2024
d37da24
Merge branch 'soroban-merge/platforms' of https://github.com/ElliotFr…
briwylde08 Feb 28, 2024
64835d8
fix broken links
ElliotFriend Feb 28, 2024
9b2c1a6
Merge branch 'soroban-merge/platforms' of github.com:ElliotFriend/ste…
ElliotFriend Feb 28, 2024
69e252e
use the default DocItem component for soroban-rpc pages, too
ElliotFriend Feb 28, 2024
abbcc22
Add RPC providers and usage to RPC section
briwylde08 Feb 28, 2024
24aa68c
Merge branch 'soroban-merge/platforms' of https://github.com/ElliotFr…
briwylde08 Feb 28, 2024
ab7c465
Change Hubble Overview to Introduction to align
briwylde08 Feb 29, 2024
2dd4cb5
Add Horizon Introduction content
briwylde08 Feb 29, 2024
c13df44
Shuffle RPC sections
briwylde08 Feb 29, 2024
567f599
use README.mdx conventions in anchor platform admin guide
ElliotFriend Feb 29, 2024
c851454
Merge branch 'soroban-merge/platforms' of github.com:ElliotFriend/ste…
ElliotFriend Feb 29, 2024
e65706f
fix broken links
ElliotFriend Feb 29, 2024
95e2ce8
use README.mdx conventions in horizon
ElliotFriend Feb 29, 2024
0a3aade
use README.mdx convention for soroban-rpc
ElliotFriend Feb 29, 2024
e4ea6c2
fix link, formatting
briwylde08 Feb 29, 2024
0d17619
fix more broken links
ElliotFriend Feb 29, 2024
172b95d
use README.mdx conventions in sdp
ElliotFriend Feb 29, 2024
b3b2138
Merge branch 'soroban-merge/platforms' of github.com:ElliotFriend/ste…
ElliotFriend Feb 29, 2024
1c4f593
fix a whole bunch of broken links
ElliotFriend Feb 29, 2024
238f733
Horizon structural changes
briwylde08 Mar 1, 2024
4091dd7
Update outdated code. (#759)
overcat Mar 1, 2024
a733607
nicer look for menu dropdown subtitles
ElliotFriend Mar 1, 2024
3f95a2a
expand soroban rcp methods category by default
ElliotFriend Mar 1, 2024
47d16ff
move core node docs to "Network" section
ElliotFriend Mar 1, 2024
c5554e8
rename platforms to network
ElliotFriend Mar 1, 2024
7e8acb1
fix broken links, styles, etc.
ElliotFriend Mar 1, 2024
6a19b5c
use default DocItem for core-node docs
ElliotFriend Mar 1, 2024
6f4b659
add link to Network dropdown and style the active dropdown item
ElliotFriend Mar 1, 2024
33b090a
more README.mdx uses in anchor platform
ElliotFriend Mar 1, 2024
b2eb98c
fix broken links
ElliotFriend Mar 1, 2024
a970e86
change filepaths in redocly scripts `api/` -> `network/`
ElliotFriend Mar 1, 2024
9cb8603
first stab at nginx redirects
ElliotFriend Mar 1, 2024
452fdfb
use more README.mdx in horizon
ElliotFriend Mar 1, 2024
5e2e893
more README.mdx files in horizon
ElliotFriend Mar 1, 2024
e926bbd
more README.mdx files (almost done i think?)
ElliotFriend Mar 1, 2024
4ef9e34
final batch of README.mdx files
ElliotFriend Mar 1, 2024
ad80875
change platforms to network in soroban-rpc openrpc URLs
ElliotFriend Mar 1, 2024
19c6ca3
Merge remote-tracking branch 'subset/main' into soroban-merge/platforms
ElliotFriend Mar 4, 2024
358e93a
Merge branch 'main' into soroban-merge/platforms
ElliotFriend Mar 5, 2024
a91fc0f
fix a broken link
ElliotFriend Mar 5, 2024
2717acc
add the rpcspec command to the docker build file
ElliotFriend Mar 5, 2024
e8658b1
move updated getLedgerEntries page into the correct location
ElliotFriend Mar 5, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
5 changes: 4 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,7 @@ yarn-error.log*

.idea

*.info.mdx
*.info.mdx

# non-production openrpc.json files
/openrpc/*openrpc.json
1 change: 1 addition & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ RUN apt-get update && apt-get install --no-install-recommends -y gpg curl git ma
COPY . /app/

RUN yarn install
RUN yarn rpcspec:build
RUN yarn build

FROM nginx:1.17
Expand Down
5 changes: 0 additions & 5 deletions api/anchor-platform/callbacks/_category_.json

This file was deleted.

5 changes: 0 additions & 5 deletions api/anchor-platform/custody-server/_category_.json

This file was deleted.

4 changes: 0 additions & 4 deletions api/anchor-platform/introduction/_category_.json

This file was deleted.

5 changes: 0 additions & 5 deletions api/anchor-platform/resources/_category_.json

This file was deleted.

5 changes: 0 additions & 5 deletions api/anchor-platform/rpc/_category_.json

This file was deleted.

4 changes: 0 additions & 4 deletions api/horizon/aggregations/_category_.json

This file was deleted.

5 changes: 0 additions & 5 deletions api/horizon/aggregations/fee-stats/_category_.json

This file was deleted.

19 changes: 0 additions & 19 deletions api/horizon/aggregations/index.mdx

This file was deleted.

4 changes: 0 additions & 4 deletions api/horizon/aggregations/order-books/_category_.json

This file was deleted.

4 changes: 0 additions & 4 deletions api/horizon/aggregations/paths/_category_.json

This file was deleted.

4 changes: 0 additions & 4 deletions api/horizon/aggregations/trade-aggregations/_category_.json

This file was deleted.

4 changes: 0 additions & 4 deletions api/horizon/errors/_category_.json

This file was deleted.

4 changes: 0 additions & 4 deletions api/horizon/errors/http-status-codes/_category_.json

This file was deleted.

4 changes: 0 additions & 4 deletions api/horizon/errors/result-codes/_category_.json

This file was deleted.

This file was deleted.

4 changes: 0 additions & 4 deletions api/horizon/introduction/_category_.json

This file was deleted.

30 changes: 0 additions & 30 deletions api/horizon/introduction/index.mdx

This file was deleted.

5 changes: 0 additions & 5 deletions api/horizon/introduction/pagination/_category_.json

This file was deleted.

5 changes: 0 additions & 5 deletions api/horizon/resources/_category_.json

This file was deleted.

25 changes: 0 additions & 25 deletions api/horizon/resources/index.mdx

This file was deleted.

This file was deleted.

5 changes: 0 additions & 5 deletions api/stellar-disbursement-platform/resources/_category_.json

This file was deleted.

24 changes: 0 additions & 24 deletions api/stellar-disbursement-platform/resources/index.mdx

This file was deleted.

8 changes: 0 additions & 8 deletions docs/accessing-data/_category_.json

This file was deleted.

7 changes: 0 additions & 7 deletions docs/anchoring-assets/anchor-platform/_category_.json

This file was deleted.

This file was deleted.

This file was deleted.

7 changes: 0 additions & 7 deletions docs/anchoring-assets/anchor-platform/events/_category_.json

This file was deleted.

7 changes: 0 additions & 7 deletions docs/anchoring-assets/anchor-platform/sep1/_category_.json

This file was deleted.

7 changes: 0 additions & 7 deletions docs/anchoring-assets/anchor-platform/sep10/_category_.json

This file was deleted.

7 changes: 0 additions & 7 deletions docs/anchoring-assets/anchor-platform/sep24/_category_.json

This file was deleted.

7 changes: 0 additions & 7 deletions docs/anchoring-assets/anchor-platform/sep31/_category_.json

This file was deleted.

7 changes: 0 additions & 7 deletions docs/anchoring-assets/anchor-platform/sep6/_category_.json

This file was deleted.

2 changes: 1 addition & 1 deletion docs/encyclopedia/anchors.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Stellar has anchor services operating worldwide. View the [Anchor Directory](htt

Anchors can issue their own assets on the Stellar network, or they can honor assets that already exist.

You can set up an anchor by using the SDF-maintained [Anchor Platform](../anchoring-assets/anchor-platform), which is the easiest way to deploy an anchor service compatible with Stellar Ecosystem Proposals (SEPs).
You can set up an anchor by using the SDF-maintained [Anchor Platform](/network/anchor-platform), which is the easiest way to deploy an anchor service compatible with Stellar Ecosystem Proposals (SEPs).

Learn how to integrate anchor services into your blockchain-based application by viewing the [Build Apps section](../building-apps/overview.mdx). If you’re looking specifically for MoneyGram Access, see the Integrate with MoneyGram Access tutorial.

Expand Down
4 changes: 2 additions & 2 deletions docs/fundamentals-and-concepts/stellar-stack.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ Stellar Core is the program used by the individual nodes (or computers) that mak

Nodes reach consensus using the Stellar Consensus Protocol, which can you can learn more about here: [Stellar Consensus Protocol](./stellar-consensus-protocol)

Anyone can run a Stellar Core node, but you don’t have to in order to build on Stellar. We recommend you do so if you issue an asset and want to ensure the accuracy of the ledger, if you want to participate in network governance by voting on protocol version, minimum fees, and resource and ledger limits, and/or if you want to contribute to Stellar’s overall health and decentralization. Check out our tutorial on installing, configuring, and maintaining your own node here: [Run a Core Node Tutorial](../run-core-node).
Anyone can run a Stellar Core node, but you don’t have to in order to build on Stellar. We recommend you do so if you issue an asset and want to ensure the accuracy of the ledger, if you want to participate in network governance by voting on protocol version, minimum fees, and resource and ledger limits, and/or if you want to contribute to Stellar’s overall health and decentralization. Check out our tutorial on installing, configuring, and maintaining your own node here: [Run a Core Node Tutorial](/network/core-node).

## Platform Services

Horizon is the client-facing RESTful HTTP API server in the platform layer which allows programmatic access to submit transactions and query the network’s historical data. It acts as the interface for applications that want to access the Stellar network. You can communicate with Horizon using an SDK, a web browser, or with simple command tools like cURL.

You do not need to run your own Horizon instance — when you're getting started, you can use the free SDF Horizon instance to access the network — but it is recommended that you do when you’re ready to launch a finished product. Check out how to do so here: [Run Platform Services Tutorial](../run-platform-server)
You do not need to run your own Horizon instance — when you're getting started, you can use the free SDF Horizon instance to access the network — but it is recommended that you do when you’re ready to launch a finished product. Check out how to do so here: [Run Platform Services Tutorial](/network/horizon/admin-guide)

Learn all there is to know about using Horizon in the Horizon [API Reference documentation](https://developers.stellar.org/api).

Expand Down
7 changes: 0 additions & 7 deletions docs/run-core-node/_category_.json

This file was deleted.

7 changes: 0 additions & 7 deletions docs/run-platform-server/_category_.json

This file was deleted.

7 changes: 0 additions & 7 deletions docs/stellar-disbursement-platform/_category_.json

This file was deleted.

This file was deleted.

Loading
Loading