open-location-code icon indicating copy to clipboard operation
open-location-code copied to clipboard

Please move all wiki articles into the repository // MOVE SHORT CODE SPEC

Open fulldecent opened this issue 3 years ago • 3 comments

Please move all the wiki articles into the repository.

There are currently normative statements in the Wiki. Those should be under code control and should be open to discussion/PR inside this repository.


Requesting that these be copied as-is for now (even with broken links). And then everybody can help to clean them up together.

I myself have many corrections to make to those as per https://github.com/google/open-location-code/pull/463. And maybe if all the files are here this can help us make progress on all these things.

fulldecent avatar Jun 28 '22 18:06 fulldecent

New documentation tree (using existing names) I plan to move things to. That will empty the wiki and then it can be turned off.

Existing files

  • Documentation (renamed from docs)
    • reference
      • comparison.adoc: Comparison of location encoding systems (was previously in repo, got moved to wiki, move back)
    • specification
      • API.md: API requirements for implementations
      • olc_definition.adoc: Background/description of Open Location Code project
      • specification.md: Open Location Code technical specification

From wiki

drinckes avatar Jun 14 '24 11:06 drinckes

Todo(@drinckes): Merge API.md and short code guidelines into specification.md, but I have to do some actual work now too.

drinckes avatar Jun 14 '24 13:06 drinckes

Perfect, thank you. Hopefully this makes it easier to manage. I see

  • [ ] Merge API.md and short code guidelines into specification.md, but I have to do some actual work now too.

Are there any other high-priority action items directly related to this wiki merge that you wanted to highlight now?

fulldecent avatar Jul 19 '24 17:07 fulldecent