Skip to content

Conversation

@chrstfer
Copy link

The docs in this repo focus on the extractor, they don't explain the entirety of the newpipe codebase. This should be made clear everywhere it isn't, starting with the site name, so prospective contributors coming for an explanation of the architecture of the newpipe app's repo don't waste their time.

There are probably other spots that clarification should be made, which i will change as I am made aware of them.

The docs in this repo focus on the extractor, they don't explain the entirety of the newpipe codebase. This should be made clear everywhere it isn't, starting with the site name, so prospective contributors coming for an explanation of the architecture of the newpipe app's repo don't waste their time.
@TheAssassin
Copy link
Member

The site https://teamnewpipe.github.io/documentation/ does not refer only to the extractor, the proposed change does not make any sense to me. The page never claims to explain the code base. It's a general guideline for contributors.

@chrstfer
Copy link
Author

chrstfer commented Aug 19, 2021

The site https://teamnewpipe.github.io/documentation/ does not refer only to the extractor, the proposed change does not make any sense to me. The page never claims to explain the code base. It's a general guideline for contributors.

The majority of the doc is about newpipe extractor, the only time it refers to the newpipe repository is in the context of testing the extractor. It also only links to the newpipe extractor javadoc, but refers to it as if it were the whole of the project. Rather than documentation the current doc reads like its a tutorial focused on how to use the extractor codebase. That's not a knock on it, but it should be a sub-section of the doc, which I suggest be reorganized. I propose we structure it like this:

Newpipe Documentation
- Project Architecture (Design Doc)
- Schema Documentation
  - ...
- Newpipe Repo (App)
  - Javadoc
  - Overview
  - Suggested IDE setup and Build Instructions/FAQ/Notes (this doesn't even exist in any comprehensive manner!)
  - ...
- Newpipe Extractor Repo
  - Javadoc
  - Overview
  - Suggested IDE setup and Build Instructions/FAQ/Notes
  - Tutorial (adding an extractor; basically the whole of the current documentation)
  - ...

quick edit:
I realize this is a large restructuring, which is why I also propose we create a wiki that can act as a draft/proposal/beta version of the official docs, to facilitate communication between editors. I don't know whether using the github repository wiki feature or doing it on the documentation site would be preferable, though. Whichever is easiest.

@TheAssassin
Copy link
Member

Closed by #34.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants