Php-graph-sdk: Convert docs to standard markdown

Created on 12 Oct 2016  路  8Comments  路  Source: facebookarchive/php-graph-sdk

Then we can link from the official docs to the repo wiki to make sure the docs are always up-to-date. :)

Hacktoberfest low hanging fruit

All 8 comments

Aha I just answered you by email! Here my throughts:
I agree about moving the doc to GitHub, but I don't think using the GitHub Wiki feature is a good idea...
I think it's better to keep the doc in the repo, but convert it to Markdown (it will be a tedious work...).
Then, we can require any PR to have its associated doc :)

BTW, in the future, we may use GitHub Pages and Couscous to have an online version of the doc!

Just tagged this as "low-hanging fruit" for anyone who wants to take it on! :) Here are the current docs in Facebook's flavor of markdown. We just have to:

  1. [x] Rename the files to .md
  2. [ ] Remove/update any fbmd to standard or GitHub markdown
  3. [ ] Update links pointed to /docs/php/* to point to the correct doc file in the repo

Just posted the first PR for this (#676) if you want more help in what needs to be done. :)

Now that the docs are organized a bit better, we need to go through each of the files and:

  • Remove Facebook-style markup:

    • Remove <card></card> tags

    • Remove Facebook header anchors ({#*} in headers e.g. ## Example {#example} -> ## Example)

    • Convert code blocks from ~~~~ /* */ ~~~~ to php /\* */

    • Convert %FB(devsite:markdown-wiki:info-card {*}) to a quote block: > *

    • Convert %FB(devsite:markdown-wiki:table {*}) to a table block

  • Update all Graph API version references to v2.8
  • Update links to point to either the relative path (/docs/php/FacebookCanvasHelper -> docs/reference/FacebookCanvasHelper.md) or the corresponding Facebook documentation for non PHP SDK links (/docs/javascript -> https://developers.facebook.com/docs/javascript)
  • Fix any type-o's you come across for there are many. :)

Let's get this really fleshed-out for v5 on master & I'll cherry-pick all the commits to the latest 5.x branch. Once completed, we'll update the docs on master to start reflecting v6. :)

Hi! :wave: I'll tackle this list now.

Clarification question: we're updating all the docs on this list, right? Does it make sense to merge #677 (for the new .md extensions) before I go through the files?

Hey @nayafia! Thanks for taking this one on! :) I've merged #677 so we should be good to go. And yes, all the files in docs/ that have fbmd in them need to be converted which should be all of them except for docs/README.md at the moment. :)

Thanks @nayafia!

Was this page helpful?
0 / 5 - 0 ratings