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

Make DS Wiki Obsolete #88

Open
1 of 6 tasks
alex-Symbroson opened this issue Oct 17, 2023 · 1 comment
Open
1 of 6 tasks

Make DS Wiki Obsolete #88

alex-Symbroson opened this issue Oct 17, 2023 · 1 comment

Comments

@alex-Symbroson
Copy link
Collaborator

alex-Symbroson commented Oct 17, 2023

SteveG — 08/08/2023 16:18
I've been looking around the Wiki to see what might be of use in any new system and the truth is it's pretty much obsolete
It started out because the docs were very sketchy but they outshine the ancient code in the wiki now
There are some intents that are most easily found in the wiki but I suspect that's about all we need to salvage

Tasks:

  • scan wiki for remaining content
  • transfer content into wiki

Content

  • Intent description and examples
  • Tips & Tricks
  • Sample Code
  • Getting Started
alex-Symbroson pushed a commit to SymDSTools/Docs that referenced this issue Nov 3, 2023
alex-Symbroson added a commit to SymDSTools/Docs that referenced this issue Nov 3, 2023
alex-Symbroson added a commit to SymDSTools/Docs that referenced this issue Feb 10, 2024
@TonyGravagno
Copy link
Collaborator

I'm hoping that the DS wiki can be revitalized rather than removed. Yes, the content is obsolete, but a wiki itself isn't obsolete, especially for this project.

Documentation tells us about specific artifacts: objects, methods, events

A wiki tells us what we can do with those things. It helps to add context to what is found in the documentation. It's a place to reference comments about how something was used, challenges, work-arounds, best practices, and changes that are specific to Android versions.
A wiki contains metadata about the product, rather than details about what is in the product. It tells us how the product works, not just about each component in isolation.

I think the wiki can be replaced with a new MediaWiki site, with valid content migrated, content that's duplicated in the docs removed, and anything else archived.

I haven't looked at it, but the new Discourse forum has some kind of wiki integration. We might not need separate software. If approved, I'll look into the possibilities.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants