Skip to content

chore(docs): update hashes page to pull in code#4175

Merged
TomAFrench merged 6 commits intomasterfrom
tf/blackbox-update
Jan 26, 2024
Merged

chore(docs): update hashes page to pull in code#4175
TomAFrench merged 6 commits intomasterfrom
tf/blackbox-update

Conversation

@TomAFrench
Copy link
Copy Markdown
Member

@TomAFrench TomAFrench commented Jan 25, 2024

Description

Problem*

Resolves #4176

Summary*

Additional Context

Documentation*

Check one:

  • No documentation needed.
  • Documentation included in this PR.
  • [Exceptional Case] Documentation to be submitted in a separate PR.

PR Checklist*

  • I have tested the changes locally.
  • I have formatted the changes with Prettier and/or cargo fmt on default settings.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 25, 2024
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jan 25, 2024

@TomAFrench TomAFrench requested a review from a team January 25, 2024 20:57
@TomAFrench TomAFrench added this pull request to the merge queue Jan 26, 2024
Merged via the queue into master with commit 5e3c0f1 Jan 26, 2024
@TomAFrench TomAFrench deleted the tf/blackbox-update branch January 26, 2024 19:08
@TomAFrench TomAFrench mentioned this pull request Jan 29, 2024
@Savio-Sou
Copy link
Copy Markdown
Collaborator

Savio-Sou commented Jan 29, 2024

Thank you @TomAFrench!

Would the use of #include_code work per version when docs are cut into versioned_docs as well?

As in for example if #include_code is used in versioned_docs/version-v0.23.0, would it pull code at v0.23.0's commit instead of from the latest master?

@TomAFrench
Copy link
Copy Markdown
Member Author

Not perfectly.

The way it works is that on the release PR, we'll generate a version in versioned_docs with the snippets resolved to the code as of the release PR. The markdown is then frozen with the content as of that commit (i.e. we don't codegen for versioned docs after when the version is cut), the links however will still point towards master and so will become stale over time.

We could modify this so that the links point towards the release tag however in future.

@Savio-Sou
Copy link
Copy Markdown
Collaborator

Clarification appreciated. Will make sure to copy content rather than codegen for the retro additions into v0.23.0 in that case.

@signorecello
Copy link
Copy Markdown
Contributor

Yep those retro additions wouldn't be codegen-ed anyway so the page would look terrible 😊 so it's hard to make a mistake there

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Pull blackbox function signatures from stdlib definitions

4 participants