Skip to content

Refine Mintlify docs change management #1598

@lightwalker-eth

Description

@lightwalker-eth

Background

  • A number of enhancements to our Mintlify docs are being introduced in feat(docs): OpenAPI spec sync with CI validation and PR previews #1550.
  • In PR 1550, ideas were added to docs/docs.ensnode.io/README.md warning about how to manage documenting unreleased features using separate PRs for documentation updates related to these features. This is a really unfortunate and inconvenient complexity.
  • We had a similar issue for ENSAdmin in the past, which we solved through the strategy in:
    • .github/scripts/promote_ensadmin.sh
    • ... as triggered through .github/workflows/deploy_switch_ensnode_environment.yml
  • In theory we could apply the same solution to our Mintlify docs as we used for ENSAdmin, but unfortunately Mintlify's https://www.mintlify.com/docs/api/update/trigger API doesn't allow for us to pass a commit-SHA to trigger a rebuild from. If they did, this should give us a solution.

An inquiry for this capability has been sent to Mintlify's support team:

Image

Goals

  • When we ask Mintlify to update the production docs, ideally it could always be from the same commit SHA as the ENSNode instance we're currently running in production.
    • This would also require us tell Mintlify to stop automatically building new production docs with each commit to main.

Related

Metadata

Metadata

Assignees

Labels

devopsDevOps relateddocsDocs related

Type

Projects

Status

Todo

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions