Skip to content

Separate opcodes page for each TEAL version#1156

Merged
nullun merged 8 commits intoalgorandfoundation:stagingfrom
jasonpaulos:teal-opcodes-per-version
Oct 5, 2023
Merged

Separate opcodes page for each TEAL version#1156
nullun merged 8 commits intoalgorandfoundation:stagingfrom
jasonpaulos:teal-opcodes-per-version

Conversation

@jasonpaulos
Copy link
Copy Markdown
Contributor

Companion PR to algorand/go-algorand#5629, which generates a TEAL_opcodes_v%d.md file for each TEAL version, instead of just a single TEAL_opcodes.md file.

This change allows the docs site to show all available opcodes markdown files.

The real change is in scripts/reformat-all-commands.sh, which changes how the files are copied in from go-algorand.

Copy link
Copy Markdown
Contributor

@ryanRfox ryanRfox left a comment

Choose a reason for hiding this comment

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

Please modify the links to jsonspec.md in the following files:

  • v9.md
  • v8.md
  • v7.md

Check this section of code for the invalid link (in needs to be one level prior):

## json_ref

- Syntax: `json_ref R` ∋ R: [json_ref](#field-group-json_ref)
- Bytecode: 0x5f {uint8}
- Stack: ..., A: []byte, B: []byte → ..., any
- key B's value, of type R, from a [valid](jsonspec.md) utf-8 encoded json object A
- **Cost**: 25 + 2 per 7 bytes of A
- Availability: v7

I'll suggest:

- key B's value, of type R, from a valid utf-8 encoded json object A (see: [JSON Spec](../jsonspec.md))

@jasonpaulos
Copy link
Copy Markdown
Contributor Author

Good catch @ryanRfox. I've updated the script to fix that link, and I have regenerated the files based on the latest go-algorand changes

Copy link
Copy Markdown
Collaborator

@nullun nullun left a comment

Choose a reason for hiding this comment

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

Thanks for doing this! I made a small PR to your fork that updates the links to the latest opcode version, but otherwise I'm happy with it. https://github.com/jasonpaulos/algorand-docs/pull/1/files

Link to the latest version of the opcodes page
@nullun nullun merged commit 37630ed into algorandfoundation:staging Oct 5, 2023
@jasonpaulos jasonpaulos deleted the teal-opcodes-per-version branch October 5, 2023 18:40
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.

3 participants