offchainlabs / arbitrum-docs Goto Github PK

I.e., on https://developer.arbitrum.io/useful-addresses they're too wide for the page, italicized, etc. (Some of this is from residual stuff from the pre-nitro docs that just needs to be updated/removed)

Source: https://developer.offchainlabs.com/public-chains

Request: (how can we help?)

New docs page, list of external links to stuff others have created that could be useful to arbitrum devs / learners:

currently it just says "Aribtrum docs" for each page

give clear guidance to people who want to contribute

Source: https://developer.arbitrum.io/getting-started-devs

Request: (how can we help?)

...to Arbitrum blue - 28a0f0 (in banner at least, maybe also elsewhere?)

Source: https://developer.offchainlabs.com/mainnet-beta

Request: (how can we help?)

Source: https://developer.offchainlabs.com/public-chains

Request: (how can we help?)

Source: https://developer.arbitrum.io/node-running/node-providers

Request: please update that that GetBlock supports Arbitrum Nova (on dedicated nodes) and today we add Goerly to our support too

Source: https://developer.offchainlabs.com/intro

Request: (how can we help?)

https://developer.arbitrum.io/ / https://github.com/OffchainLabs/arbitrum-docs/blob/master/arbitrum-docs/node-running/node-providers.md page.

Should be relatively "comprehensive", include a DYOR disclaimer at the top, and be listed in just say alphabetical order.

Remove individual paragraph descriptions and replace with a standardized table, i.e,

Name:
(Arbitrum) Chains Supported:
Free Tier: (y or n)
Docs:

For the address alias section https://developer.arbitrum.io/arbos/l1-to-l2-messaging, input address, display alias. It'll be fun

They’re uppercased for the purpose of Go exporting functions for our ABI binding, but they’re actually lowercase as users access them from solidity. This applies both to the “common precompiles” and “full precompiles” documents.

original ticket created by @PlasmaPower on 6 Dec 2022

I.e., move changes from OffchainLabs/nitro#1344 (and address feedback given in that PR here)

Source: https://developer.arbitrum.io/getting-started-devs

Request: (how can we help?)

Psst, this issue will be closed with a templated response if it isn't a documentation update request.

Switch to darkmode & reload, CSS breaks; not (trivially) reproducible locally

Description

Since docusaurus has i18n plugin support so we can easily add i18n support. But we still need to restructure our dictionary path, the way we make the file to support i18n is to re-structure the arbitrum-docs dictionary:

Currently:

+--  arbitrum-docs/
      +--  arbos/
      +--  assets/
      +--  ....

Change to:

+--  arbitrum-docs/
      +--  en/
             +--  arbos/
             +--  assets/
             +--  ....
      +--  cn/
             +--  arbos/
             +--  assets/
             +--  ....

Prepare instructions to build Arbitrum Nitro from sources

Source: https://developer.arbitrum.io/asset-bridging

Request: (how can we help?)

For discussion: have a single source of truth in the docs for system parameters we mention throughout (like, i.e., 24 hours for the delayed inbox period) and render each of them via little react components so we can easily modify them in lockstep if/when they change.
As a bonus, a nice unified public "system parameters" page could come out of this as well.

link to token contracts repo, not old monorepo

https://github.com/OffchainLabs/config-monorepo/tree/main/packages/prettier-config

Is your feature request related to a problem? Please describe.
IPC support recently landed in the 2.0.7 release. Notably, the official documentation for running a Nitro node currently lacks instructions on how to run a Nitro node both:

• In Docker, and
• Exposing the node's IPC capabilities

Describe the solution you'd like
Instructions added to the official documentation for operating a Nitro node that includes (working) commands for starting the node from within Docker and that is able to communicate with host processes via IPC.

Describe alternatives you've considered
None.

Additional context
N/A

Is your feature request related to a problem? Please describe.
There's no section about dStorage description, like https://ethereum.org/en/developers/docs/storage/

Describe the solution you'd like
Add dStorage under devs' wiki page

Source: https://developer.arbitrum.io/getting-started-devs

Request: (how can we help?)

Source: https://developer.arbitrum.io/inside-arbitrum-nitro/

Request: (how can we help?)

why am I not eligible even though I have lots of transactions

Source: https://developer.arbitrum.io/asset-bridging

Request: (how can we help?)

Psst, this issue will be closed with a templated response if it isn't a documentation update request.

Is your feature request related to a problem? Please describe.
there are no docs about how to use docker-compose.yaml to start service. the testnode-scripts service need more doc.

Describe the solution you'd like
add doc like https://github.com/ethereum-optimism/optimism/blob/develop/CONTRIBUTING.md

Describe alternatives you've considered
A clear and concise description of any alternative solutions or features you've considered.

Additional context
Add any other context or screenshots about the feature request here.

Source: https://developer.arbitrum.io/public-chains

Request: (how can we help?)

already throws a warning (locally)

Hey everyone.

I have forked and cloned to my machine (following README instructions). So I have the doc running in localhost but when I try to add content for Supra Oracles (under For Devs), I don't see the content I added at all even on For Devs category on the sidebars and there is a module not found error. I see that there is a CONTRIBUTING.md guide coming soon.

TLDR: I want to add content for SupraOracles incl. guides specifically on how dapp developers in arbitrum ecosystem can start trying out our price feeds data and VRF products.

About SupraOracles

SupraOracles is a novel, high-throughput Oracle & IntraLayer: A vertically integrated toolkit of cross-chain solutions (data oracles, asset bridges, automation network, and more) that interlink all blockchains, public (L1s and L2s) or private (enterprises).

We have integrated Arbitrum goerli testnet for both price feeds data and VRF and ETA for mainnet alpha is late February/early march.

Source: https://developer.arbitrum.io/arbitrum-ethereum-differences

Request: (how can we help?)

Something like: keep a js mapping of word-id to definition; can wrap any text in a component that inputs an id and tooltips the definition (glossary page will use the same mapping to render the text directly)

Source: https://developer.arbitrum.io/public-chains

Request: (how can we help?)

maybe on landing page?

Source: https://developer.arbitrum.io/for-users/troubleshooting-users

Request: (how can we help?)

Originally posted by @SPPrague in #158

• generate sdk docs against both v2 and v3 branches
• use docusaurus versioning feature?
  https://docusaurus.io/docs/migration/versioned-sites#populate-your-versioned_sidebars-and-versioned_docs

Currently we do this hacky client-side thing, gives a weird flicker https://github.com/OffchainLabs/nitro-docs/blob/b07b7f06aed3221a65458961d33fa0949c815e8d/website/src/pages/index.js#L11

Source: https://developer.arbitrum.io/getting-started-devs

Request: (how can we help?)

Psst, this issue will be closed with a templated response if it isn't a documentation update request.

Source: https://developer.arbitrum.io/for-users/troubleshooting-users

Request: (how can we help?)

No received my token not my wallet