Add GitHub NavBar type documentation

[danielchalef]

What's the issue?

Missing content (not covered in the docs)

URL of the documentation page (if applicable)

No response

Describe the gap or issue

Add GitHub NavBar type documentation

How should this be improved?

No response

Are you interested in contributing this improvement?

No

Attach Files (Optional)

No response

[vikramnagwal]

Hey @danielchalef, could you please specify what issue you are dealing with?

[danielchalef]

The NavBar item "GitHub" type is not currently documented.

…

On Mon, Mar 3, 2025 at 5:53 AM, Vikram < ***@***.*** > wrote: Hey @danielchalef ( https://github.com/danielchalef ) , could you please specify what issue you are dealing with? — Reply to this email directly, view it on GitHub ( #6259 (comment) ) , or unsubscribe ( https://github.com/notifications/unsubscribe-auth/AABAAZ6COSCAQMTEAWWHJZT2SRNE7AVCNFSM6AAAAABYERZLCWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMOJUGQ4DCMRWHE ). You are receiving this because you were mentioned. Message ID: <fern-api/fern/issues/6259/2694481269 @ github. com> *VikramNagwal* left a comment (fern-api/fern#6259) ( #6259 (comment) ) Hey @danielchalef ( https://github.com/danielchalef ) , could you please specify what issue you are dealing with? — Reply to this email directly, view it on GitHub ( #6259 (comment) ) , or unsubscribe ( https://github.com/notifications/unsubscribe-auth/AABAAZ6COSCAQMTEAWWHJZT2SRNE7AVCNFSM6AAAAABYERZLCWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMOJUGQ4DCMRWHE ). You are receiving this because you were mentioned. Message ID: <fern-api/fern/issues/6259/2694481269 @ github. com>

[cwcowell]

Hi @danielchalef , I assume you're referring to the github value that's listed as a possible value for docs.NavbarLink in fern-docs.schema.json?

fern/fern-docs.schema.json

Lines 744 to 758 in 8347bdd

	"docs.NavbarLink": {
	"type": "object",
	"properties": {
	"type": {
	"type": "string",
	"enum": [
	"filled",
	"outlined",
	"minimal",
	"github",
	"primary",
	"secondary"
	]
	}
	},

If that's what you have in mind, I'm afraid it's not currently implemented as a valid value for a NavBar item, even though it's listed in that validation file. Feel free to file a GitHub issue requesting this feature, if it's something you'd like to see implemented. Never mind -- turns out that feature is implemented after all.

[dannysheridan]

@cwcowell yes, that is what he's referring to! Not in Fern's documentation and it should be.

Site with GitHub configured: https://help.getzep.com

[cwcowell]

Nice. I thought it was not implemented because putting this in docs.yml:

navbar-links:
  - type: github
    text: foo
    url: https://github.com/getzep/graphiti

produces this error when you run fern check:

Failed.
navbar-links -> [0] -> text: Unexpected key "text"; navbar-links -> [0] -> url: Unexpected key "url"; navbar-links -> [0]: Missing required key "value"

@dannysheridan do we have an example docs.yml that demonstrates how to set up GitHub NavBar links, that I can use as a model for documenting this feature? I couldn't find a docs.yml in any of Zep's public repos to use as a model.

[dannysheridan]

@cwcowell check this out: fern-api/docs-starter#63