Remove un-needed slugs
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 1.5k
- Forks
- 228
- Avg merge
- 1d 14h
- Merged PRs (30d)
- 48
Description
We use page slugs in front matter in many pages of the project, most seem to be the result of copy/pasting existing pages when creating new ones. These should be removed wherever possible since the absolute address makes it more difficult to preview the documentation within the CLI repo itself - the slugs are designed to work only as part of the combined documentation set at https://redocly.com/docs/cli
The advantage of the slug is to support camel case in a URL (where by default we lowercase it), but the cost of more difficult documentation maintenance doesn't seem worth it so let's remove these.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search the CLI repository's documentation pages for front-matter slug fields and review which pages rely on absolute URLs in the combined documentation set. Remove slugs where they are unnecessary, while preserving cases needed for the documented URL behavior, and verify that the documentation can be previewed correctly within the CLI repository.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100