Skip to content

Consistently use kebab-case filenames for DocC articles #1758

Description

@stmontgomery

Description

Our style guide recommends using kebab-case filenames:

The filenames used for articles and API collections should match the titles of those documents. For consistency with other Swift documentation, articles and API collections in DocC bundles should use kebab-case. The DocC compiler will preserve your kebab-case filenames in the resulting documentation archive.

For example, if the title of your article is Adding tags to tests, the filename would be adding-tags-to-tests.md, or if the title of the collection page is Event tags, the filename would be event-tags.md.

The DocC compiler lowercases URL paths, so filenames converted from UpperCamelCase may be difficult to read. UpperCamelCase should still be used for Markdown files in the repository such as this one that aren't part of a DocC bundle.

But currently, most of our DocC articles use UpperCamelCase filenames — see Testing.docc. We should rename those to be kebab-case.

Additional information

No response

Metadata

Metadata

Assignees

Labels

documentation📚 Improvements or additions to documentationenhancementNew feature or request

Type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions