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

fix(cli): Set instance when migrating Mintlify > Fern #5093

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

mattblank11
Copy link

@mattblank11 mattblank11 commented Nov 4, 2024

Related to this task

Here's what the docs.yml file looks like for Bland AI with the instances value set:

instances:
  - url: https://bland-ai.docs.buildwithfern.com

@coderabbitai summary

@mattblank11 mattblank11 changed the title Set instance when migrating Mintlify > Fern fix(clo) Set instance when migrating Mintlify > Fern Nov 4, 2024
@mattblank11 mattblank11 changed the title fix(clo) Set instance when migrating Mintlify > Fern fix(cli) Set instance when migrating Mintlify > Fern Nov 4, 2024
Copy link

github-actions bot commented Nov 4, 2024

builder.setInstance({
companyName: mint.name
});
this.context.logger.debug("Set instance");
Copy link
Contributor

Choose a reason for hiding this comment

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

do we want to output the name here, as well?

Copy link
Author

Choose a reason for hiding this comment

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

Good idea, updating now!

Copy link
Author

Choose a reason for hiding this comment

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

@RohinBhargava are you thinking that we should output the name from the mint file or the name we auto-generate?

Copy link
Contributor

Choose a reason for hiding this comment

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

good question! I think you have the most context, but I would assume mint.name, given the locality of the debug statement to the invocation

Copy link
Member

Choose a reason for hiding this comment

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

@mattblank11 could see this being: Added instance ${url} to docs.yml

Copy link
Author

Choose a reason for hiding this comment

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

Appreciate the input!

I agree with @dsinghvi on returning the url, if anything. IMO it's weird to return a string from the setInstance function but I don't love the alternative of creating a separate getInstanceUrl function. Feel free to push back on this!

@mattblank11 mattblank11 changed the title fix(cli) Set instance when migrating Mintlify > Fern fix(cli): Set instance when migrating Mintlify > Fern Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

3 participants