Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Create a user guide with more detailed examples #125

@eonu

Description

@eonu

Does this suggestion already exist?

  • This is a new feature!

Feature description

The current Sphinx-generated API reference is useful for learning basic usage patterns of the package.

However, there are many features of Feud, or ways to combine features that can be used in more complex usage patterns to achieve many different things in the generated CLI.

These detailed usage examples don't belong in the API reference, and should be contained in a separate user guide.

The user guide should also show integrations (which should work in theory), e.g. click-contrib and trogon.

Proposed stack


Hosted at feud.wiki/guide or guide.feud.wiki.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions