search

zulip / zulip-terminal

Official Zulip terminal client.
Apache License 2.0
666 stars 253 forks source link

Write developer documentation for zulip-terminal. #27

Open amanagr opened 6 years ago

amanagr commented 6 years ago

Things we should include:

amanagr commented 6 years ago

I have started working on this here. @punchagan @timabbott FYI

Ezio-Sarthak commented 3 years ago

What's the status of this issue @amanagr ? I'd love to work on the issue, if currently no one's working :)

neiljp commented 3 years ago

@Ezio-Sarthak Thanks for checking back on this early issue :+1:

Right now many of the core "how do I do..." type tasks should be listed in the development-related part of the README. Given you're a relatively new contributor, any thoughts you have on that type of content that felt missing or unclear would be much appreciated - you're more likely to see issues, being fresh to everything :)

The developer documentation Aman referred to in 2018 was previously in the wiki and has since been migrated along with other wiki pages into docs/. Since more general text was added to the README separately then these have become out of sync, though should have been updated recently.

Looking at the developer-documention.md file in docs/ it feels like this could be split more cleanly into:

I'd suggest that with the presence of the README the pytest section is now duplicate material and could be removed. We should likely just mention urwid in the general README, if it is not mentioned enough already. For the tutorial, I think we should rename the existing file into eg. developer-feature-tutorial.md, or maybe even more specific. For the overview (file structure), I think we could either replace it with good docstrings for each source file, or supplement by automating extraction of those into something like the table we have now with some general intro text on the code organization.

Beyond that - or even now - then I think we should probably close this issue in favor of more specific issues/PRs, as a lot has changed since when this was opened!

Ezio-Sarthak commented 3 years ago

I'll do share my thoughts on missing/unclear things during this period of exploration and learning!

I agree about the pytest section duplication. I'll remove it from developer-documentation.md. For urwid, I'll add related info in README.md :+1:

Tutorial should be specifically a single file (maybe something like developer-add-feature-tutorial.md ?)

For the overview, I think replacing it with docstrings should be a good option. Could you elaborate on the automated extraction ? :sweat_smile:

Rohitth007 commented 3 years ago

@neiljp The developer tutorial file seems outdated can I work on this?

Rohitth007 commented 3 years ago

@zulipbot claim

zulipbot commented 3 years ago

Hello @Rohitth007, you claimed this issue to work on it, but this issue and any referenced pull requests haven't been updated for 10 days. Are you still working on this issue?

If so, please update this issue by leaving a comment on this issue to let me know that you're still working on it. Otherwise, I'll automatically remove you from this issue in 4 days.

If you've decided to work on something else, simply comment @zulipbot abandon so that someone else can claim it and continue from where you left off.

Thank you for your valuable contributions to Zulip!

Rohitth007 commented 3 years ago

@zulipbot @neiljp I think the PR #966 is ready to be merged, could you take a look at this?

ankur0904 commented 1 year ago

If no one is working on this issue I can try to write the documentation.

@neiljp