FHIR / FHIR/sushi

Allow for selectively overriding parts of SUSHI's automatic page naming and inclusion

Open
#1,052 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
TypeScript
Stars
188
Forks
64
Avg merge
8d 11h
Merged PRs (30d)
3

Description

Currently you can either allow SUSHI to name pages for you (based on filename) _or_ you can name them yourself, but then you have to fully specify all pages in `sushi-config.yaml`. Some users would like a way to have SUSHI name most pages for you, but allow you to override names on certain pages. There was also a request to support a way to omit pages.

See: https://chat.fhir.org/#narrow/stream/179252-IG-creation/topic/markdown.20page.20title/near/276401394

Contributor guide

Open the contributing guide

Research direction

Start by tracing SUSHI's automatic page naming and the page configuration described in sushi-config.yaml. The change is done when users can keep automatic naming for most pages while overriding selected names and omitting selected pages, with behavior covered by the relevant tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.