patternfly / patternfly/patternfly-doc-core

Enable full screen examples

Open
#97 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

PF Team
Dominant language
TypeScript
Stars
2
Forks
11
Avg merge
5d 15h
Merged PRs (30d)
1

Description

Full screen examples currently aren't supported in the docs core.

We should add this support, including being able to open any example as full screen.

Examples that are marked as full only should for now just show the image of the question mark that is visible in new examples in the docs framework. Adding support for screenshot preview images will be under a separate issue.


Jira Issue: PF-2331

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing how the docs core renders examples and handles examples marked as full. Add full-screen support for any example, while full-only examples show the existing question-mark image; leave screenshot preview images for the separate issue. Verify the affected example types and generated documentation behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
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.