{"id":27637900,"url":"https://github.com/ember-learn/ember-jsonapi-docs","last_synced_at":"2025-09-10T14:35:14.390Z","repository":{"id":3217816,"uuid":"48774338","full_name":"ember-learn/ember-jsonapi-docs","owner":"ember-learn","description":"fixes up the ember docs generated by YUIDoc to be in JSONAPI format + some other niceties","archived":false,"fork":false,"pushed_at":"2025-03-22T12:33:33.000Z","size":12130,"stargazers_count":9,"open_issues_count":14,"forks_count":11,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-03-22T13:33:52.568Z","etag":null,"topics":["ember","emberjs","hacktoberfest"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ember-learn.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2015-12-30T01:11:13.000Z","updated_at":"2025-03-22T12:33:37.000Z","dependencies_parsed_at":"2024-07-08T19:19:03.942Z","dependency_job_id":"4c92edfa-fd79-4a08-b81e-1f954dd3b6f0","html_url":"https://github.com/ember-learn/ember-jsonapi-docs","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ember-learn%2Fember-jsonapi-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ember-learn%2Fember-jsonapi-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ember-learn%2Fember-jsonapi-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ember-learn%2Fember-jsonapi-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ember-learn","download_url":"https://codeload.github.com/ember-learn/ember-jsonapi-docs/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250519029,"owners_count":21444072,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ember","emberjs","hacktoberfest"],"created_at":"2025-04-23T21:33:24.464Z","updated_at":"2025-09-10T14:35:14.368Z","avatar_url":"https://github.com/ember-learn.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ember JSON API Docs [![Build Status](https://github.com/ember-learn/ember-jsonapi-docs/actions/workflows/ci.yaml/badge.svg)](https://github.com/ember-learn/ember-jsonapi-docs/actions/workflows/ci.yaml)\n\n\nThis tool gets the code comments from `ember.js` and `ember-data` libraries, \nturns them into JSON files, and then turns those JSON files into a\n[JSON:API](http://jsonapi.org/) format.\n\nThe files this tool creates are used to power \n[api.emberjs.com](https://api.emberjs.com).\n\n\n\u003e ℹ️ **NOTE:** If you are looking for the front end app behind https://api.emberjs.com/, visit [ember-api-docs](https://github.com/ember-learn/ember-api-docs) instead.\n\n## Prerequisites\n\n- the latest [Node.js](https://nodejs.org/) LTS\n- [pnpm v9](https://pnpm.io/) (preferably managed via [corepack](https://github.com/nodejs/corepack))\n\nClone all of the following repositories into the same directory so they are \"siblings\" on the file system\n\n- This repository, `ember-jsonapi-docs`\n- [ember-api-docs-data](https://github.com/ember-learn/ember-api-docs-data)\n- [ember.js](https://github.com/emberjs/ember.js)\n- [ember-data](https://github.com/emberjs/data/)\n\n## Generate docs\n\nDecide which version and project you want to build docs for.\nThen, in `ember.js` and/or `ember-data` repositories, check out the version\ntags you want to generate docs for. For example:\n\n```sh\ncd ../ember.js\ngit fetch --all\ngit checkout v5.2.0-ember-source\n\nAND/OR\n\ncd ../data\ngit fetch --all\ngit checkout v5.2.0\n```\n\nGenerate the JSON docs for `ember` and/or `ember-data`. This will add new JSON\nfiles into the `s3-docs` directory of `ember-api-docs-data`:\n\n```sh\ncd ../ember-jsonapi-docs\npnpm i\npnpm gen --project ember --version \"5.2.0\"\n```\n\nI would recommend committing in ember-api-docs-data at this stage so that you can see that the following steps work.\n\n```sh\ncd ../ember-api-docs-data/\ngit add . \ngit commit -m \"add docs for ember v5.2.0\"\n```\n\nNext, we need to fix the generated files in ember-api-docs-data. (Note: this step could probably be incorporated into ember-jsonapi-docs\nbut for now this step works). The `delete_unused_files` script will return an error for `ember.json` and `ember-data.json`, this is expected\n\n```sh\nnpm i\nnpm run fix:files\ngit add .\ngit commit -m \"fix urls and rev-index for ember\"\n```\n\nLastly, we need to make sure that each of the new files are valid. You need to run the test suite in `ember-api-docs-data`\n\n```sh\nnpm i\nnpm test\n```\n\nIf you see any errors e.g. `AssertionError: expected '' not to be empty` you need to manually fix these. These are caused by bugs in the yuidoc generation and can probably be fixed in the source files somehow.\n\nOnce all of the fixes are in place you can commit them: \n\n```sh\ngit add .\ngit commit -m \"fixing tests for ember\"\n```\n\n--- \n\nOnce that is all committed I would recommend doing the same thing for ember-data with new commits: \n\n```sh\ncd ../ember-jsonapi-docs\nyarn gen --project ember-data --version \"5.2.0\"\n\ncd ../ember-api-docs-data\n\ngit add . \ngit commit -m \"add docs for ember-data v5.2.0\"\n\nnpm run fix:files\ngit add .\ngit commit -m \"fix urls and rev-index for ember-data\"\n\nnpm test\n\n# if you needed to fix any files you do that now and then\ngit add .\ngit commit -m \"fixing tests for ember-data\"\n```\n\nOnce that is all done, push it and open a PR 🎉\n\n\u003e ℹ️ **NOTE:** `--version` should match the one in the `package.json` of a target Ember project. If `package.json` uses a release name (e.g. `beta` or `canary`), omit it and use only numbers. For example, if the `package.json` says `3.19.0-beta.2`, use `3.19.0`.\n\n\u003e ✅ **TIP:** If you are debugging failed builds, periodically discard the changes\nmade to `ember-api-docs-data`, since changes are made in-place.\n\n## (Optional) View the generated docs in the `ember-api-docs` frontend\n\nIf you want to see how this content will look in the `ember-api-docs` frontend in your local environment follow [these instructions](https://github.com/ember-learn/ember-api-docs).\n \n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fember-learn%2Fember-jsonapi-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fember-learn%2Fember-jsonapi-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fember-learn%2Fember-jsonapi-docs/lists"}