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.

Sign up for GitHub

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

Jump to bottom

[README] Document the Repo to Make it More Shareable with Developers #16

Closed
pishoyg opened this issue Jul 23, 2024 · 4 comments
Closed

[README] Document the Repo to Make it More Shareable with Developers #16

pishoyg opened this issue Jul 23, 2024 · 4 comments
Assignees
@pishoyg
Labels
dev Why: Developer experience documentation How: Writing documentation
Milestone
platform v1.0

Comments

@pishoyg
Copy link
Owner

pishoyg commented Jul 23, 2024

No description provided.

@pishoyg pishoyg added documentation How: Writing documentation P0 labels Jul 23, 2024
@pishoyg
Copy link
Owner Author

pishoyg commented Aug 1, 2024 •
edited
Loading

The README part about flashcards is quite outdated.
- KELLIA information is absent!
- The Dawoud scans are absent!

This is no longer relevant, since we intend to publish that on the new home page. See #109.

@pishoyg pishoyg added the dev Why: Developer experience label Aug 3, 2024
@pishoyg pishoyg changed the title Document the Repo to Make it More Shareable [README] Document the Repo to Make it More Shareable with Developers Aug 3, 2024
@pishoyg
Copy link
Owner Author

pishoyg commented Aug 3, 2024

Just clean up the README's, and document some of your conventions.

Developers who onboard will have to talk to you anyway.

@pishoyg pishoyg self-assigned this Aug 5, 2024
@pishoyg pishoyg added p4 and removed P0 labels Aug 5, 2024
@pishoyg pishoyg removed their assignment Aug 8, 2024
@pishoyg pishoyg removed the backlog label Aug 8, 2024
@pishoyg pishoyg added this to the Improve the Developer Experience milestone Aug 9, 2024
pishoyg added a commit that referenced this issue Aug 12, 2024
@pishoyg
[#16][README] One README to Rule Them All!
eaf5a23 
```
cat dictionary/README.md >> README.md && git rm dictionary/README.md
cat bible/README.md >> README.md && git rm bible/README.md
cat flashcards/README.md >> README.md && git rm flashcards/README.md
```
pishoyg added a commit that referenced this issue Aug 12, 2024
@pishoyg
[#16][README/Pre-commit] Only the README at the Root is Allowed.
4ff6611 
Localizing the documentation will have some benefits.
@pishoyg pishoyg mentioned this issue Aug 14, 2024
Closed
pishoyg added a commit that referenced this issue Aug 14, 2024
@pishoyg
[#16][README] List Hosting Platforms.
2a69afd
@pishoyg pishoyg modified the milestones: Developer Experience, Platform Aug 26, 2024
pishoyg added a commit that referenced this issue Aug 26, 2024
@pishoyg
[#16][README] Restructure the File.
5a36ebe
pishoyg added a commit that referenced this issue Aug 31, 2024
@pishoyg
[#186,#16][Flashcards/Anki/JavaScript] Update Docs.
2b97a6b
@pishoyg pishoyg self-assigned this Aug 31, 2024
pishoyg added a commit that referenced this issue Sep 2, 2024
@pishoyg
[#220,#16][Makefile] Update Some Rules and Comments.
2bc2719 
Summary of changes:
- `kellia_analysis` is now a developer rule that is not included in the
  `all` rule.
- `mobi_publish` is now a prerequisite for `publish`. It was both
  removed and made idempotent in
  666fb13. The removal was unnecessary.
- Rename the `test` and `git_add_precommit_run` rules to simply `test`
  and `add` at level-2, and `_test` and `_add` at level-1. See in-file
  comments for the rationale.
- Rewrite some comments to make them clearer.
@pishoyg
Copy link
Owner Author

pishoyg commented Sep 2, 2024

Also, just keep this in mind when you code. Writing docs is desirable, because you won't maintain this project on your own forever.

@pishoyg pishoyg modified the milestones: platform, platform v1.0 Sep 2, 2024
pishoyg added a commit that referenced this issue Sep 9, 2024
@pishoyg
[#16, fix #161][README] Document Planning Conventions.
ea4b02c
pishoyg added a commit that referenced this issue Sep 10, 2024
@pishoyg
[#16][README,Env] Use a New Drive Directory for File Sharing.
d994a09 
We set up a new Drive directory that is:
1. Shared by all our publications.
2. Owned by [email protected].
pishoyg added a commit that referenced this issue Sep 11, 2024
@pishoyg
[#16][README] Update Diagram.
299d89f
@pishoyg pishoyg added this to coptic Sep 11, 2024
pishoyg added a commit that referenced this issue Sep 13, 2024
@pishoyg
[#16][Crum] Add Docs about Output Generation.
9da0bf9
pishoyg added a commit that referenced this issue Sep 13, 2024
@pishoyg
[#5,#240,#16][README] Update Docs, particularly about Crum's Images.
aadf54f 
Also delete obsolete docs about structure of some `data/`
subdirectories, and update various pieces of the README.
pishoyg added a commit that referenced this issue Sep 13, 2024
@pishoyg
[#16][README] General Doc Update.
33b2a4e
pishoyg added a commit that referenced this issue Sep 13, 2024
@pishoyg
[#16][README] Add Links to Repo Files and Directories.
6ac9253 
In the case of `.env`, we actually remove it, because it doesn't exist
on the repo.
pishoyg added a commit that referenced this issue Sep 13, 2024
@pishoyg
[#16][README] Update a Couple of Links.
61e7397
@pishoyg
Copy link
Owner Author

pishoyg commented Sep 13, 2024

TODO:

  1. Reference [Crum] Rethink Undialected Entries #237.
  2. Mention commit messages and the planning framework as sources of documentation.

The DoD (definition of done) for this issue is for the README to be in a good shape. Afterwards, documentation is an ongoing effort. A guideline! Something to keep in the back of your head as you work!
It will also be based on new joiners' feedback.

pishoyg added a commit that referenced this issue Sep 14, 2024
@pishoyg
[#16][README] Update Docs.
7d0f7fc
pishoyg added a commit that referenced this issue Sep 14, 2024
@pishoyg
[#16][README] Update Docs.
b32adf8
@pishoyg pishoyg moved this to In Progress in coptic Sep 14, 2024
@pishoyg pishoyg closed this as completed Sep 15, 2024
@github-project-automation github-project-automation bot moved this from In Progress to Done in coptic Sep 15, 2024
pishoyg added a commit that referenced this issue Sep 15, 2024
@pishoyg
[#16][README] Reference Closed Isseus that We May Want to Revive.
45c82c9
pishoyg added a commit that referenced this issue Sep 15, 2024
@pishoyg
[#16][README] Nit: Fix Typo.
fbe660e
pishoyg added a commit that referenced this issue Oct 2, 2024
@pishoyg
[#16][README] Fix Typo.
2d388fe
pishoyg added a commit that referenced this issue Oct 4, 2024
@pishoyg
[#16,#245][README] Add Link to Google Search Console.
2001a5c 
Nit: Also correct indentation for the paragraph about images.
pishoyg added a commit that referenced this issue Oct 7, 2024
@pishoyg
[#5,#16][README] Update the Docs about Images.
e7ddd55 
Mainly reorder them, bringing the stronger reasons earlier.
pishoyg added a commit that referenced this issue Oct 8, 2024
@pishoyg
[#16][README,Site/Home] Add License and Cited Works.
e08524d
pishoyg added a commit that referenced this issue Oct 8, 2024
@pishoyg
[#16][README] Add the Website Logo.
59efcb4
pishoyg added a commit that referenced this issue Oct 8, 2024
@pishoyg
[#16][Logo] Add a Wide Logo for Social Preview.
07dfe8c 
NOTE: It has been uploaded to GitHub through the repo Settings, to be
used a Social Preview image.
pishoyg added a commit that referenced this issue Oct 8, 2024
@pishoyg
[#16][README,Site/Home] Miscellaneous Improvements.
dd5ee96 
Summary of changes:
- Delete resized versions of the logo. Use CSS to control display
  height.
- Reuse the *License and Cited Works* HTML from the home page in your
  README.
- Include the logos for the institutions that you support (Coptic
  Orphans, and St. Shenouda The Archimandrite - Coptic Society).
- The *Upcoming Milestones* section comes after *Contact and
  Contributions*.
pishoyg added a commit that referenced this issue Oct 10, 2024
@pishoyg
[#16][Site] Add License Information to the Search Page as well.
09ba012
pishoyg added a commit that referenced this issue Oct 12, 2024
@pishoyg
[#16][Site/README] Add a README in the Site Repo with Links.
0428486 
Add a link pointing to our website, and one pointing to the original
repo.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@pishoyg pishoyg

Labels
dev Why: Developer experience documentation How: Writing documentation
Projects
coptic
Archived in project
Milestone
platform v1.0
Development

No branches or pull requests
1 participant
@pishoyg