Giter Club home page Giter Club logo

telos-docs's Introduction

Telos Docs

docs.telos.net

About

Welcome to the Telos Docs. The Telos documentation is aimed to provide a list of comprehensive guides in building on Telos for web2 and web3 developers. You can fork the docs and work in a local environment or do a PR directly on one of the pages.

Please reach out in EVM or Dapps development Telegram channels.

Our docs are built using Docusaurus 3, a modern static website generator.

Site will auto-update based on commits to the master branch, it is hosted in Cloudflare Pages.

Recent Contributions

Alt

Installation

Clone repository and install dependencies

$ git clone https://github.com/telosnetwork/telos-docs.git
$ cd telos-docs
$ yarn

Start local development server

$ yarn start

Generate production build (in build directory) which can be served using any static hosting service

$ yarn build

Deployment

Using SSH:

$ USE_SSH=true yarn deploy

Not using SSH:

$ GIT_USER=<Your GitHub username> yarn deploy

telos-docs's People

Contributors

andcjane avatar archsoftdev avatar atharvadeosthale avatar bgodlin avatar dependabot[bot] avatar donnyquixotic avatar guilledk avatar hermanuskb007 avatar jacobtlos avatar jbuice avatar jorniks avatar karynemayer avatar kasrakhosravi avatar kencastle316 avatar kersten-cr avatar ksdumont avatar nathanduft44 avatar nathanhennigh avatar omahs avatar poplexity avatar rozzaswap avatar shittuking avatar tomtomcrypto avatar viterbo avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

telos-docs's Issues

Search results link previews show old network icon in Brave search

Describe the bug
Search results link previews show old network icon

To Reproduce
Steps to reproduce the behavior:

  1. Search 'telos docs' using Brave search
  2. See screenshot

Expected behavior
Should display our new branding circle icon

Screenshots
image

Additional Details

  • Not present on google and only seems to affect Brave Browser search, it may just take longer for updates to propagate

Add instructions/clarification for EVM account creation

Description
There isn't clear information/explanation on how to create a new EVM account. It is implied in the faucet instructions for testnet but could be clarified.

Solution
Language explaining how to create a new account within MetaMask and/or clarification that TLOS can be sent to an existing MetaMask address while on telos network(s) to generate an account record. We could also add documentation for creating an account via openwallet action.

Create new article "How to create a new governance proposal in Telos Decide Web App"

Please create an article that explains the process of creating a new proposal in Telos Decide Web App.

This should be based on latest developments and frontend.

Article to include background information about different types of DAOs as well as their tokens.

Include a step by step guide and explanation of the various configuration settings.

Update staking documentation

  • Include staking instructions for the web wallet since this is the easiest happiest path, the user will also be prompted to add the network, so no need for user to manually add or add via chainlist

  • Add network prompt is also true for users visiting Teloscan for the first time (can keep the chainlist and manual configuration options documented)

  • Under 'Prerequisites' it states "If you have never used tEVM before with your Telos Zero account, the following guide will assist you in creating a tEVM account using the TLOS_Webwallet." this isn't accurate atm (guide is for Teloscan)

https://docs.telos.net/learn/defi_guide/staking_sTLOS/

Staking instructions for Native/Zero

Describe the bug
There isn't documentation for staking on the native side which works differently than EVM staking (for now). There are two ways to do it using our apps via the web wallet and open block explorer. There is a dead link in the current documentation

To Reproduce
Steps to reproduce the behavior:

  1. Go to https://docs.telos.net/faq/#what-is-rex-and-how-does-it-work
  2. Click on 'Stake Telos on an Antelope block explorer'
  3. See 404

Expected behavior
Should contain documentation and/or link to instructions for one or both methods, including information about 'savings' if relevant (OBE only atm), unstaking periods, etc.

Rebrand documentation to look like base

Issue Type

Acceptance Criteria:

Rework:

Social Links on Nav Bar:

  • Add Icon Links to top bar
  • as well as move footer to a top bar:
    - horizontal select lists that cover
    • community,
    • block explorers
    • and more sections from the footer.
  • Footer should only have copyright info.

Background:

  • Darker

Nav bar item font and size :

  • Larger
  • Thicker

Search bar positioning :

  • Larger visible searchbar

Doc Side Bar Layout, Header Font, Size

Reorganize Doc Side Bar Document Order:

  • Create a section for Oracles and Indexers that is easy to see.
  • Dev focused
  • BP Focused
  • Node Focused

Eliminate Navigation at bottom of page and force Doc Side Bar Navigation

Location

https://docs.telos.net/overview/what-is-telos/introduction/

Details

Our documentation is incoherently structured. We have Telos EVM and Telos Zero mentioned together. Telos Zero should be moved to the last line. In addition, we should strive to get close to something like Base: https://docs.base.org/docs/ We can just use the same structure as Base has. The info on Oracles, Indexers scattered on our end.

Add instructions and/or link for revoking allowances in the web wallet

Description
Revoking allowances feature is released in the web wallet, add instructions and/or a link for users. The revoke.telos.net subdomain will link to documentation and the web wallet and instruct users to revoke there.

Tasks

  • Remove link & language referencing revoke.telos.net, this subdomain is a redundant placeholder that will link users to the web wallet and documentation
  • Add instructions/link to revoke in the web wallet

Links

Update Nodes section

Tasks to be picked up by the start of 10/3

  1. Update Antelope.io(Leap) installation guide
  2. Setting up Archive node guide

Telos 3.1 workshop

Overview

The goal of this issue is to map and discuss the effort required to have a new workshop for the 3.1 release where we show how to set up a node.

Acceptance criteria

Tasks

Telos logo svg not rendering correctly in firefox

Describe the bug
See screenshot

Screenshots
image

Desktop (please complete the following information):

  • Browser: Firefox

Additional context
Renders correctly in Chrome, this is browser-specific. You will need a new svg or a png file. You can find the working png file used in OBE here.

Update Zero linked EVM address documentation

Describe the bug
Outdated pages & routes are still accessible. Remove, disable and/or redirect to docs homepage.

To Reproduce
Steps to reproduce the behavior:

  1. Go to example

Expected behavior
Users should not be able to directly navigate to outdated documentation

Broken links (missing files)

Description
Missing linked markdown and license files

  • On source page path = /native/eosio_toolkit/ -> linking to ./03_before-you-begin.md (resolved as: /native/eosio_toolkit/03_before-you-begin.md)
  • On source page path = /native/eosio_toolkit/contract_dev_toolkit -> linking to ./LICENSE (resolved as: /native/eosio_toolkit/LICENSE)

Once resolved, revert config onBrokenLinks param value back to 'throw' (currently set to 'warn' to prevent breaking cloudflare build, see #86 )

Document resources used by current node types

Description
Add the resources used by various node types:

  • simple api node from snapshot without block history
  • api with block history
  • state history with and without Hyperion (for both testnet and mainnet)
  • disk size would be as of a point in time, and should state that time

EVM Indexer API doc

Description

Our API uses swagger for documentation but we need to document the filter language for the topics in the event route

Task

  • General EVM Indexer API introduction
  • Document topics filter for event route

Landing page welcome text on desktop

Describe the bug
Landing page text looks janky on desktop (fine on mobile).

To Reproduce
Steps to reproduce the behavior:

  1. Go to docs.telos.net
  2. See screenshot

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
image

Desktop (please complete the following information):

  • Browser: Chrome

Broken links causing cloudflare build to fail

Description
Broken links causing cloudflare build to fail

Solution(s)
Change onBrokenLinks config param from 'throw' to 'warn' or resolve/remove dead links

Screenshot (Cloudflare)
image

Lingering EOSIO references

Description
A couple lingering places where EOSIO references could be updated to reference AntelopeIO.

Examples

  • routes
  • images/diagrams

Screenshot
image

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.