adapt_framework icon indicating copy to clipboard operation
adapt_framework copied to clipboard

delete 2 sections of adaptlearning/documentation repo

Open chucklorenz opened this issue 4 years ago • 3 comments

  1. I recommend deleting two sections of the adaptlearning/documentation repo: 05_wiki_changelog 06_wiki_style_guide These are vestiges of the documentation prep for the release of v3. I don't believe there is value in retaining them.

  2. Does this repo warrant being pinned on the main github page? There must be many people who come along looking for help/documentation, see this repo and jump in, only to leave confused. Yes, I'm totally aware of the description below the repo title--but we know how people are: act first; read later. I don't know how frequently core developers are referencing the repo, but it appears that the contents don't change often. And core developers should be sharp enough to find the repo quickly if not pinned. Anyway, just a suggestion to nix a potential source of confusion for visitors to the github page.

chucklorenz avatar Mar 26 '21 11:03 chucklorenz

~~I think 06_wiki_style_guide should be kept as I believe it is linked to from some other pages (the contributing page?) but certainly needs updating~~ sorry, wrong style guide! yes this one should go. the coding style guide could use a refresh!

06_wiki_changelog yes definitely delete

and yes agree completely this should not be pinned

moloko avatar Mar 26 '21 14:03 moloko

Personally not aware of anything linking to the style guide. I proposed it as an incomplete draft to Sven back when we prepping v3. I never heard back. Great if someone is linking to it. Great if someone thinks it might have future value as a foundation for a new and improved guide. Just stumbled through the repo yesterday and thought about tidying up--being Spring and all. 😉

chucklorenz avatar Mar 26 '21 18:03 chucklorenz

@chucklorenz I've unpinned the documentation repo from the main page and pinned adapt-cli instead

moloko avatar Apr 12 '21 17:04 moloko

deleted section

oliverfoster avatar Sep 05 '22 10:09 oliverfoster