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

feat(docs): allow reference to a particular commit or tag #5711

Open
wei3erHase opened this issue Aug 24, 2023 · 1 comment
Open

feat(docs): allow reference to a particular commit or tag #5711

wei3erHase opened this issue Aug 24, 2023 · 1 comment
Labels
C-forge Command: forge Cmd-forge-doc Command: forge doc T-feature Type: feature

Comments

@wei3erHase
Copy link

Component

Forge

Describe the feature you would like

When running forge doc, there's a reference to the git source in the mdbook, that aims to the latest (current) commit from which the docs are generated. On normal development process, dev and main branches should be locked and accessible through PRs, that may be squashed and merged into, so the "latest commit" from which the docs are generated ends up being inexistent.

  • Add a way of specifying a commit hash or a github tag to the "source code"

Additional context

No response

@wei3erHase wei3erHase added the T-feature Type: feature label Aug 24, 2023
@gakonst gakonst added this to Foundry Aug 24, 2023
@github-project-automation github-project-automation bot moved this to Todo in Foundry Aug 24, 2023
@wei3erHase wei3erHase changed the title forge(doc): allow reference to a particular commit or tag feat(docs): allow reference to a particular commit or tag Aug 24, 2023
@lnist
Copy link

lnist commented Jan 12, 2024

It would be beneficial to be able to give the entire prefix http url. We currently generate docs from a different repository than the one with the solidity files (by referencing an npm package with the files), and this generates urls to the wrong repository also.

@zerosnacks zerosnacks added C-forge Command: forge Cmd-forge-doc Command: forge doc labels Jul 3, 2024
@zerosnacks zerosnacks added this to the v1.0.0 milestone Jul 26, 2024
@grandizzy grandizzy removed this from the v1.0.0 milestone Oct 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-forge Command: forge Cmd-forge-doc Command: forge doc T-feature Type: feature
Projects
Archived in project
Development

No branches or pull requests

4 participants