Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Remove docs & improve README#14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
giograno merged 5 commits intomainfromdocs
Dec 27, 2024
Merged

Remove docs & improve README#14

giograno merged 5 commits intomainfromdocs
Dec 27, 2024

Conversation

@giograno
Copy link
Member

After an internal discussion (mostly after feedback from@thrau), I decided to drop the sphinx docs and keep all the docs related to the SDK in our official userdocumentation.

One of the biggest pro of sphinx was the API reference generation from docstrings which we can still re-introduce at some point in the official docs, if we want. I'd argue that the reference becomes less important once we open-source this repo.

In the context of this PR, I also improved our README, with a pointer to the docs for a quickstart and code samples.

@giogranogiograno marked this pull request as ready for reviewDecember 11, 2024 22:40
Copy link
Member

@alexrashedalexrashed left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

After an internal discussion (mostly after feedback from@thrau), I decided to drop the sphinx docs and keep all the docs related to the SDK in our official userdocumentation.
One of the biggest pro of sphinx was the API reference generation from docstrings which we can still re-introduce at some point in the official docs, if we want. I'd argue that the reference becomes less important once we open-source this repo.

I think this is a very interesting discussion to have. It's totally fine to take them down for now, but it would be super interesting what the reasoningagainst publishing their own fine-grained docs is (in the PR description you only mentioned the "pro" of Sphinx).

I found a small issue in the README (wrong badge) which would be good to fix before merging, the rest of my comments really are just nitpicks. These shouldn't be blocking the merge (and are quite subjective I would say).

giogranoand others added4 commitsDecember 12, 2024 14:58
Co-authored-by: Alexander Rashed <2796604+alexrashed@users.noreply.github.com>
Co-authored-by: Alexander Rashed <2796604+alexrashed@users.noreply.github.com>
Co-authored-by: Alexander Rashed <2796604+alexrashed@users.noreply.github.com>
Co-authored-by: Alexander Rashed <2796604+alexrashed@users.noreply.github.com>
@giograno
Copy link
MemberAuthor

giograno commentedDec 27, 2024
edited
Loading

@alexrashed I was convinced by our internal discussion (especially bythe comment of@thrau).
I was very attracted by the automatic generation of the API reference from docstrings but:

  • we can still do this in the future in our main docs;
  • getting started guides and code samples are more important for adoptions (and we have these already in themain docs).

@giogranogiograno merged commit74f08bd intomainDec 27, 2024
@giogranogiograno deleted the docs branchDecember 27, 2024 09:12
giograno added a commit that referenced this pull requestJan 27, 2025
giograno added a commit that referenced this pull requestJan 27, 2025
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@alexrashedalexrashedalexrashed approved these changes

@HarshCasperHarshCasperAwaiting requested review from HarshCasper

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@giograno@alexrashed

[8]ページ先頭

©2009-2025 Movatter.jp