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

Make article-only catalog pages language-less #240

Open
franklinsch opened this issue May 9, 2022 · 0 comments
Open

Make article-only catalog pages language-less #240

franklinsch opened this issue May 9, 2022 · 0 comments
Labels
bug Something isn't working

Comments

@franklinsch
Copy link
Contributor

franklinsch commented May 9, 2022

Currently, the language of pages in article-only catalogs, i.e., catalogs that define a @TechnologyRoot, is "Swift" (arbitrarily), since there isn't really a language that can be inferred for them.

We should instead track these as language-less (availableSourceLanguages: []) or as a special .undefined language. This will require relaxing the navigator index logic to still include these pages, despite not being of language Swift, Objective-C, or Data.

Swift-DocC Version Information

Swift-DocC version: e761687

rdar://118461894

@franklinsch franklinsch added the bug Something isn't working label May 9, 2022
franklinsch added a commit to franklinsch/swift-docc that referenced this issue May 9, 2022
For article-only catalogs, i.e., catalogs that use @TechnologyRoot,
don't emit the variants array in the render node, so that renderers
don't display the page's language, since it doesn't have a language.

A longer-term fix here would be to not consider articles in article-only
catalogs to be "Swift", and implement logic in RenderNodeTranslator to
not emit variants information for language-less pages
(github.com/swiftlang/issues/240).

rdar://92758192
franklinsch added a commit to franklinsch/swift-docc that referenced this issue May 9, 2022
For article-only catalogs, i.e., catalogs that use @TechnologyRoot,
don't emit the variants array in the render node, so that renderers
don't display the page's language, since it doesn't have a language.

A longer-term fix here would be to not consider articles in article-only
catalogs to be "Swift", and implement logic in RenderNodeTranslator to
not emit variants information for language-less pages
(github.com/swiftlang/issues/240).

rdar://92758192
franklinsch added a commit to franklinsch/swift-docc that referenced this issue May 10, 2022
For article-only catalogs, i.e., catalogs that use @TechnologyRoot,
don't emit the variants array in the render node, so that renderers
don't display the page's language, since it doesn't have a language.

A longer-term fix here would be to not consider articles in article-only
catalogs to be "Swift", and implement logic in RenderNodeTranslator to
not emit variants information for language-less pages
(github.com/swiftlang/issues/240).

rdar://92758192
franklinsch added a commit to franklinsch/swift-docc that referenced this issue May 10, 2022
For article-only catalogs, i.e., catalogs that use @TechnologyRoot,
don't emit the variants array in the render node, so that renderers
don't display the page's language, since it doesn't have a language.

A longer-term fix here would be to not consider articles in article-only
catalogs to be "Swift", and implement logic in RenderNodeTranslator to
not emit variants information for language-less pages
(github.com/swiftlang/issues/240).

rdar://92758192
franklinsch added a commit to franklinsch/swift-docc that referenced this issue May 10, 2022
For article-only catalogs, i.e., catalogs that use @TechnologyRoot,
don't emit the variants array in the render node, so that renderers
don't display the page's language, since it doesn't have a language.

A longer-term fix here would be to not consider articles in article-only
catalogs to be "Swift", and implement logic in RenderNodeTranslator to
not emit variants information for language-less pages
(github.com/swiftlang/issues/240).

rdar://92758192
franklinsch added a commit to franklinsch/swift-docc that referenced this issue May 12, 2022
For article-only catalogs, i.e., catalogs that use @TechnologyRoot,
don't emit the variants array in the render node, so that renderers
don't display the page's language, since it doesn't have a language.

A longer-term fix here would be to not consider articles in article-only
catalogs to be "Swift", and implement logic in RenderNodeTranslator to
not emit variants information for language-less pages
(github.com/swiftlang/issues/240).

rdar://92758192
franklinsch added a commit that referenced this issue May 12, 2022
For article-only catalogs, i.e., catalogs that use @TechnologyRoot,
don't emit the variants array in the render node, so that renderers
don't display the page's language, since it doesn't have a language.

A longer-term fix here would be to not consider articles in article-only
catalogs to be "Swift", and implement logic in RenderNodeTranslator to
not emit variants information for language-less pages
(github.com//issues/240).

rdar://92758192
franklinsch added a commit to franklinsch/swift-docc that referenced this issue Jun 9, 2022
For article-only catalogs, i.e., catalogs that use @TechnologyRoot,
don't emit the variants array in the render node, so that renderers
don't display the page's language, since it doesn't have a language.

A longer-term fix here would be to not consider articles in article-only
catalogs to be "Swift", and implement logic in RenderNodeTranslator to
not emit variants information for language-less pages
(github.com/swiftlang/issues/240).

rdar://92758192
franklinsch added a commit to franklinsch/swift-docc that referenced this issue Jun 9, 2022
For article-only catalogs, i.e., catalogs that use @TechnologyRoot,
don't emit the variants array in the render node, so that renderers
don't display the page's language, since it doesn't have a language.

A longer-term fix here would be to not consider articles in article-only
catalogs to be "Swift", and implement logic in RenderNodeTranslator to
not emit variants information for language-less pages
(github.com/swiftlang/issues/240).

rdar://92758192
franklinsch added a commit that referenced this issue Jun 9, 2022
For article-only catalogs, i.e., catalogs that use @TechnologyRoot,
don't emit the variants array in the render node, so that renderers
don't display the page's language, since it doesn't have a language.

A longer-term fix here would be to not consider articles in article-only
catalogs to be "Swift", and implement logic in RenderNodeTranslator to
not emit variants information for language-less pages
(github.com//issues/240).

rdar://92758192
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant