Skip to content
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: move documentation to wiki #642

Merged

Conversation

h4sh3d
Copy link
Member

@h4sh3d h4sh3d commented Aug 10, 2022

Documentation is moved to the project's wiki to ease of maintenance.

Copy link
Member

@zkao zkao left a comment

Choose a reason for hiding this comment

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

I'm not convinced about this one, because then the docs aren't in a git repo, that a dev clones and can read in his editor. Additionally, it seems fragile to further depend on third party infrastructure (now to read the docs)

@h4sh3d
Copy link
Member Author

h4sh3d commented Aug 10, 2022

If a dev clone that repo he has an access to the wiki, if you want we can add the wiki git as an indication in the readme so he can also clone the doc.

@Lederstrumpf
Copy link
Member

Lederstrumpf commented Aug 10, 2022

I'm not convinced about this one, because then the docs aren't in a git repo, that a dev clones and can read in his editor. Additionally, it seems fragile to further depend on third party infrastructure (now to read the docs)

If you had opened up the wiki, you'd have seen it's still markdown in a git repo (with a cloning link), just more accessible, in particular for non-devs. No fragility induced by moving it to its own repo where GitHub can present it with a convenient navigation sidepanel.

Copy link
Member

@Lederstrumpf Lederstrumpf left a comment

Choose a reason for hiding this comment

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

ACK - good call to merge our info resources.

On a related (to reviewing this) & fun note, I can really recommend delta as a diff engine: https://github.com/dandavison/delta

@Lederstrumpf Lederstrumpf merged commit b3effef into farcaster-project:main Aug 10, 2022
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.

3 participants