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

Docs reorg #257

Merged
merged 5 commits into from
Feb 20, 2024
Merged

Docs reorg #257

merged 5 commits into from
Feb 20, 2024

Conversation

BrandtH22
Copy link
Contributor

@BrandtH22 BrandtH22 commented Jan 30, 2024

NOTE - this is a connected pr for the docs reorg both prs will need to be merged in a timely manner to avoid broken links: Chia-Network/chia-docs#491

  • migrates items from docs.chia.net to the chialisp site with the goal of reducing the back and forth.
  • updates links for the above
  • updates the header for alignment with the docs site

Integration of the following from docs.chia.net:
- all within chialisp-primer
- all within chialisp-concepts
- the coinset conditions doc
updates links for all docs moved from docs.chia to chialisp
update header for ease of access and alignment with the docs site
hoffmang9
hoffmang9 previously approved these changes Jan 30, 2024
Copy link
Member

@hoffmang9 hoffmang9 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Leeroy Jenkins!

@danieljperry
Copy link
Contributor

I think a little bit of clarity could be added to the Introduction page. While it does state that Chialisp compiles into CLVM, it's not totally clear what CLVM is used for. While this is clarified later, it's not immediately obvious in the introduction. Someone visiting this site for the first time should be able to discern quickly that:

  1. Chia's blockchain uses a lower-level on-chain programming language CLVM
  2. CLVM is Turing complete and has extensible opcodes, thus allowing any functionality you can dream of
  3. Absent a hard fork, CLVM will always be Chia's on-chain language
  4. Chialisp is a higher level language that compiles into CLVM
  5. Other languages could be developed in the future that also compile into CLVM; however, for now, (nearly) all on-chain programming is done in Chialisp
  6. Those wishing to create their own smart coins will want to use this site as a reference; they will need to acquire a deep understanding of Chialisp
  7. Those wanting to create an application that uses existing smart coins will only need a basic understanding of how Chialisp works; most of their development will be done using more familiar languages such as Python, Rust, or Javascript

@BrandtH22
Copy link
Contributor Author

BrandtH22 commented Jan 31, 2024

I think a little bit of clarity could be added to the Introduction page. While it does state that Chialisp compiles into CLVM, it's not totally clear what CLVM is used for. While this is clarified later, it's not immediately obvious in the introduction. Someone visiting this site for the first time should be able to discern quickly that:

1. Chia's blockchain uses a lower-level on-chain programming language CLVM

2. CLVM is Turing complete and has extensible opcodes, thus allowing any functionality you can dream of

3. Absent a hard fork, CLVM will always be Chia's on-chain language

4. Chialisp is a higher level language that compiles into CLVM

5. Other languages could be developed in the future that also compile into CLVM; however, for now, (nearly) all on-chain programming is done in Chialisp

6. Those wishing to create their own smart coins will want to use this site as a reference; they will need to acquire a deep understanding of Chialisp

7. Those wanting to create an application that uses existing smart coins will only need a basic understanding of how Chialisp works; most of their development will be done using more familiar languages such as Python, Rust, or Javascript

Completely agreed on all points, since this PR is intended to align with the docs reorg, content of pages is a bit out of scope but I have added this as an issue here #258 . Once we have this reorg completed my focus shifts to SEO optimizations and content on the pages so the modifications are still a priority 👍

@mando222 mando222 merged commit cee41e7 into main Feb 20, 2024
8 checks passed
@mando222 mando222 deleted the docs-reorg branch February 20, 2024 18:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants