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

Move file uploads doc to its own page #98

Merged
merged 3 commits into from
Oct 25, 2023

Conversation

Meschreiber
Copy link
Contributor

This PR moves the file uploads info to its own page for greater discoverability in the search bar.

It purposefully does not add file uploads to the nav bar, since this isn't really a functionality we recommend. (Folks will be able to find it if they actively search for "file uploads" though.

@calvincestari
Copy link
Member

@Meschreiber you mention that adding it to the nav bar is not recommended but does that mean the only way users will be able to find this new page is now through a search?

Looking at the Kotlin docs they do have the uploads page in the nav bar - see config.json too. I think it's helpful to have it there where it's visible beyond just search.

@Meschreiber
Copy link
Contributor Author

@calvincestari , sure we can add it! I was actually referencing how React did theirs (with no file-uploads.mdx in the config.json), but am happy to align ios with Kotlin. (And of course, we should align all three clients at some point.)

Do you have an inclination for the best section to stick it in the ios nav?

@calvincestari
Copy link
Member

calvincestari commented Oct 24, 2023

(And of course, we should align all three clients at some point.)

Yes, I agree.

Do you have an inclination for the best section to stick it in the ios nav?

We have a "Networking" section that might align with the content?

@Meschreiber
Copy link
Contributor Author

Hmm, I feel like Networking is an option, but maybe not exactly where folks would expect to see it.

As strange as it feels having a section with only one page in it, I think we can mirror the Kotlin docs nav and stick it in an "Advanced" section that we can continue to grow with other pages.

@calvincestari
Copy link
Member

As strange as it feels having a section with only one page in it, I think we can mirror the Kotlin docs nav and stick it in an "Advanced" section that we can continue to grow with other pages.

Sure, I'm fine with a new "Advanced" section. We can probably move the "Advanced Network Configuration" page into that new section too and retitle it "Customizing the Request Chain"?

@Meschreiber
Copy link
Contributor Author

Works for me!

Copy link
Member

@calvincestari calvincestari left a comment

Choose a reason for hiding this comment

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

LGTM!

docs/source/config.json Show resolved Hide resolved
@Meschreiber
Copy link
Contributor Author

Yay, thanks for the collaboration @calvincestari ! Looks like I'll need you to do the merge since I don't have write access to this repo. :)

@calvincestari calvincestari merged commit 4a22f7c into apollographql:main Oct 25, 2023
10 checks passed
BobaFetters pushed a commit that referenced this pull request Oct 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants