audreyfeldroy / audreyfeldroy/sphinx-gui

Features we want ?

Open
#3 2 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
121
Forks
25
PR merge metrics
No merged PRs in 30d

Description

What I want want what I really really want...
Anyone feel a song coming on..

MAIN PROBLEM:
We need to make developers spatially aware of where they are in the sphinx scenario..

We need a wizard made easy and even sphinx-gui is self repliating..

Need to create a projects snapshot.. and git aware..
So developers can make it easier...

Goals..
start writing stuff and then,,,
See the output dev to dev,.....

How soon will we eat "dog food" ?

We want a preview window as One type ..
syntax high in markdown amark up ..
we can play with real and virtual side by side to make it fun

Whos gonna /use this ?
All of us..

what we want,...
Simple way to knock out the docs and part of lib..
we need to be the best thing since sliced bread for snakes..

By defacto its an intermix here between..
pydoc style
rst style
sphinx
only fro html's sake....

Contributor guide

Open the contributing guide

Research direction

No files, tests, or entry points are named. Start by narrowing the competing goals—wizard, project snapshot and Git awareness, preview window, and side-by-side documentation editing—and establish which part is in scope; the issue does not define a testable completion condition.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, python
Domain
desktop, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
15/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.