Coder Social home page Coder Social logo

cadence-lang.org's People

Contributors

alilloig avatar aliserag avatar bthaile avatar bymi15 avatar chasefleming avatar dsainati1 avatar feliperibeirolabs avatar gregsantos avatar ianthpun avatar j1010001 avatar joshuahannan avatar jribbink avatar m-peter avatar narangchirag avatar nialexsan avatar supuns avatar tarakby avatar turbolent avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

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

cadence-lang.org's Issues

[FEATURE] improving documentation for Int and UInt

Issue to be solved

it's not exactly clear according to the documentation what UInt and Int's precisions are.The current doc only mentions that it's an arbitrary size. Doing some digging it seems like the underlying implementation is a big.Int in Go with an initializer that bounds it to int64. This is particularly troublesome when someone needs to sync a piece of on-chain struct/event field into their database while not knowing the precision.

Suggest A Solution

improve documentation so that it's clear to developers what the max value of Int/UInt is. I understand the "arbitrary" argument in the context of Go, but can't wrap my head around this idea in a blockchain where everything is highly deterministic.

What are you currently working on that this is blocking?

No response

Document updatability of events

Issue to be solved

The Contract Updatability page does not currently document the rules for updating events.

For example, it is allowed to remove events.

Suggest A Solution

Document rules

What are you currently working on that this is blocking?

No response

[FEATURE] Security page

Issue to be solved

The website should describe how Cadence cares about security.

Suggest A Solution

  • Add a new /security page and link to it in the top navigation bar
  • On the page:
    • Explain how Cadence provides security for contracts
    • Explain how the Cadence implementation itself is secured
  • Encourage responsible security reports (link to responsible disclosure page)
  • Link to the past security announcements in the forum

What are you currently working on that this is blocking?

No response

[FEATURE] Community page

Issue to be solved

The website should describe how Cadence is a community project.

Suggest A Solution

  • Add a new /community page and link to it in the top navigation bar
  • On the page:
    • Explain how Cadence is a community-driven project
    • Mention ways of how developers/users can contribute
      • Link feature request template on GitHub
      • Link to FLIPs, explain how giving feedback on FLIPs is useful, explain how, how to write a new FLIP, etc
      • Explain repos (cadence, cadence-tools)
      • Link to GitHub issues marked as "good first issue" in Cadence repos

Text:

Welcome to the Cadence community!

Together, we are working to build a programming language to empower everyone to push the boundaries of smart contracts and on-chain logic. 

What are you currently working on that this is blocking?

No response

[BUG] Edit this page links are broken

Current Behavior

When you click on the Edit this page link on any section it takes you to an empty url.

Expected Behavior

URLs should include /blob/main

Steps To Reproduce

Click the link

Environment

Doesn't matter

What are you currently working on that this is blocking?

No response

Flesh out capability revocation example

Issue to be solved

This section https://cadence-lang.org/docs/1.0/design-patterns#capability-revocation mentions capability revocation but it does not have a concrete examples. These scenarios are often hard for newcommers to grasp.

Suggest A Solution

Create an example of how to grant a ExampleNFT minter resource to another account that can be revoked. The same example can also be used in order to showcase how to permaently give a minter to another account, event though it can be argued that doing so is not really wise.

What are you currently working on that this is blocking?

Reviewing cadence docs page

add a web page icon

Issue to be solved

https://cadence-lang.org/ does not have a web page icon that shows:

  • on search engine results (for instance on google)
  • on browser tabs

This gives the impression that the web page is not official or well maintained

Suggest A Solution

Use the new Cadence icon as the site icon

What are you currently working on that this is blocking?

No response

Improve Documentation in the leadup to Cadence 1.0

Issue to be solved

Review cadence docs

Language Reference

Tasks

Tutorial

Tasks

The bigger picture

These things might be strange about flow to others but it is not mentioned

  • transactions and scripts are programs
  • they compose
  • an account can have multiple contracts
  • an account can have multiple keys
  • a key can be in multiple accounts

[BUG] clicking all search results does not honor version

Current Behavior

  • select 1.0 as version in docs
  • search for "exists"
  • click all results (the fact that i have to scroll down to find this link is not good)
  • the search results shown are for 0.42 not 1.0

Expected Behavior

  • the search results shown are for 1.0

Steps To Reproduce

  • select 1.0 as version in docs
  • search for "exists"
  • click all results (the fact that i have to scroll down to find this link is not good)
  • the search results shown are for 0.42 not 1.0

Environment

this is not relevant for this bugreport

What are you currently working on that this is blocking?

Stable cadence

[BUG] Incorrect versioning

Current Behavior

Going to https://cadence-lang.org/docs/1.0 shows

This is documentation for Cadence 1.0, which is no longer actively maintained.

For up-to-date documentation, see the latest version (0.42).

Expected Behavior

1.0 should be considered the upcoming version, and 0.42 should be the released version.

Steps To Reproduce

See above

Environment

Any

What are you currently working on that this is blocking?

No response

[FEATURE] Route for current documentation (https://cadence-lang.org/docs)

Issue to be solved

There is currently no way to go / link to the current documentation without knowing the version number.

For example, the current documentation is at https://cadence-lang.org/docs/0.42, but that will change in the future

Suggest A Solution

Add a route for https://cadence-lang.org/docs, which redirects to the current documentation, e.g. https://cadence-lang.org/docs/0.42.

This redirect should also work for sub-pages.

This feature exists on developers.flow.com. For example, https://developers.flow.com/cadence/language/syntax is the documentation for the Syntax of Cadence in the current version.

What are you currently working on that this is blocking?

No response

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.