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 H1s to avoid duplication with vblang repo #3788

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

Conversation

Youssef1313
Copy link
Member

@Youssef1313 Youssef1313 commented Aug 10, 2020

The dotnet/docs repository is built from both csharplang and vblang repositories.

Currently, duplicate-h1s is a suggestion that will become a warning next month.

This PR adds suffix to the headings to avoid duplication with vblang repo.

I'll open a PR in vblang to maintain consistency.

Related to dotnet/docs#19929

spec/arrays.md Outdated Show resolved Hide resolved
spec/arrays.md Outdated Show resolved Hide resolved
spec/attributes.md Outdated Show resolved Hide resolved
spec/basic-concepts.md Outdated Show resolved Hide resolved
spec/classes.md Outdated Show resolved Hide resolved
spec/conversions.md Outdated Show resolved Hide resolved
spec/statements.md Outdated Show resolved Hide resolved
spec/structs.md Outdated Show resolved Hide resolved
spec/types.md Outdated Show resolved Hide resolved
spec/unsafe-code.md Outdated Show resolved Hide resolved
spec/variables.md Outdated Show resolved Hide resolved
@Youssef1313
Copy link
Member Author

@333fred Thanks for review. I've applied your suggestion. I'll also do the same in the PR for vblang now

@BillWagner
Copy link
Member

@Youssef1313 This may not be necessary. I've started an internal dialog about the duplicate headers suggestion.

There are a couple reasons I'd prefer an engineering solution for publishing these on docs:

  • We won't be adding the extra text for the ECMA standard. Adding it to the source means we need to strip it off before submitting to ECMA or ISO. That means more work on the tool that converts markdown to Word for the standard orgs.
  • There's also F#, which is hosted in a different location. That language spec has similar duplicated titles.
  • The reason for the suggestion is SEO, and there are other clues for better SEO success: the URL, the title suffix for example.

Let's not close this, but let's wait before merging or spending more time improving them.

Base automatically changed from master to main March 12, 2021 19:15
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.

None yet

3 participants