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

Update H1/H2 headings throughout #78

Merged
merged 12 commits into from
Aug 23, 2023
Merged

Update H1/H2 headings throughout #78

merged 12 commits into from
Aug 23, 2023

Conversation

pwoznic
Copy link
Contributor

@pwoznic pwoznic commented Aug 23, 2023

Fixed headings throughout the docs so that pages would not have multiple H1's

Update the About link to correct the 404 error. Then add a Social Media link to Vectara's Discord channel.
Add doc_meta example and update curl command syntax with single quotes around URL
Update doc_metadata example
Fix example for doc_meta
Updated a few statements based on team discussion around indexing
80 char spacing
Users need to be careful so that they do not accidentally share their keys or tokens in public channels. I added this note to three topics that discuss API keys and OAuth tokens.
Updated spacing to resolve conflict
Update information about the Vectara platform along with information about common use cases

Update sidebar to reflect changes
Updated H1 headings to be H2 or H3 where appropriate and also fixed some typos
@netlify
Copy link

netlify bot commented Aug 23, 2023

Deploy Preview for luxury-shortbread-acee05 ready!

Name Link
🔨 Latest commit f76fc60
🔍 Latest deploy log https://app.netlify.com/sites/luxury-shortbread-acee05/deploys/64e646a39fe8cb000847f479
😎 Deploy Preview https://deploy-preview-78--luxury-shortbread-acee05.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Copy link
Collaborator

@cjcenizal cjcenizal left a comment

Choose a reason for hiding this comment

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

Looks great!! Had a couple non-blocking comments.

Also I noticed that the first page's "Not sure where to start?" heading appears as a child of "Language Agnostic", which seems like a mistake because the two aren't related. Should "Not sure where to start?" be an h2?

image

@@ -24,7 +24,7 @@ Valid filter expressions for this would be something like:
* `part.lang = 'deu'`
* `part.lang = 'eng' OR part.lang = 'deu'`

## part.is_title
## part.is_title field
Copy link
Collaborator

Choose a reason for hiding this comment

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

Same here

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thank you! I made the suggested updates in my latest commit

Updated headings based on feedback
@pwoznic pwoznic marked this pull request as ready for review August 23, 2023 17:50
@pwoznic
Copy link
Contributor Author

pwoznic commented Aug 23, 2023

Moved from draft to ready for review

@pwoznic pwoznic merged commit d3a3497 into vectara:main Aug 23, 2023
6 checks passed
@pwoznic pwoznic deleted the headings branch August 24, 2023 01:49
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.

Fix heading hierarchy so pages normalize off h2 as the base heading level
2 participants