wagtail / wagtail/guide

Integrate guide into existing Wagtail project and allow for extension

Open
#397 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

content
Dominant language
Python
Stars
36
Forks
39
Avg merge
2d 5h
Merged PRs (30d)
3

Description

It would be extremely helpful if we could integrate guide with an already existing project that would allow us to further customize it and even extend with overview of used components in a particular project. Similar to storybook and others where anyone can navigate to available component to see how it is used, implemented and what are options for it.

As the guide would function for basic lookaround and introduction, the extension could bring the needed individuality and additional guides meant more for internal use.

Examples of storybooks or component overviews:
https://react-kawaii.vercel.app/
https://storybook.nextui.org/?path=/story/components-listbox--with-bottom-content

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

No files or tests are named. Start by reviewing the guide's current project structure and the linked Storybook examples, then define how an existing Wagtail project could integrate with and extend the guide. Done should include an agreed extension approach and a documented component-overview use case.

Written by the indexing model from the issue text.

Assessment

Tech stack
django, python
Domain
developer-experience, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.