-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Add Atom's API docs to the Flight Manual #541
Commits on Apr 30, 2019
-
Configuration menu - View commit details
-
Copy full SHA for 786dd03 - Browse repository at this point
Copy the full SHA 786dd03View commit details -
Configuration menu - View commit details
-
Copy full SHA for 8c9fe2d - Browse repository at this point
Copy the full SHA 8c9fe2dView commit details -
Configuration menu - View commit details
-
Copy full SHA for 3ec7b61 - Browse repository at this point
Copy the full SHA 3ec7b61View commit details
Commits on May 13, 2019
-
Configuration menu - View commit details
-
Copy full SHA for ca5643e - Browse repository at this point
Copy the full SHA ca5643eView commit details
Commits on May 22, 2019
-
Configuration menu - View commit details
-
Copy full SHA for e2ad79e - Browse repository at this point
Copy the full SHA e2ad79eView commit details
Commits on May 24, 2019
-
Configuration menu - View commit details
-
Copy full SHA for c2d23c5 - Browse repository at this point
Copy the full SHA c2d23c5View commit details
Commits on Jun 10, 2019
-
Configuration menu - View commit details
-
Copy full SHA for 4b98ceb - Browse repository at this point
Copy the full SHA 4b98cebView commit details -
Configuration menu - View commit details
-
Copy full SHA for 1c85628 - Browse repository at this point
Copy the full SHA 1c85628View commit details
Commits on Jun 25, 2019
-
Configuration menu - View commit details
-
Copy full SHA for 6ccef21 - Browse repository at this point
Copy the full SHA 6ccef21View commit details -
Configuration menu - View commit details
-
Copy full SHA for 069d94d - Browse repository at this point
Copy the full SHA 069d94dView commit details -
Configuration menu - View commit details
-
Copy full SHA for 0984b6f - Browse repository at this point
Copy the full SHA 0984b6fView commit details -
Configuration menu - View commit details
-
Copy full SHA for 8bc9122 - Browse repository at this point
Copy the full SHA 8bc9122View commit details
Commits on Jun 26, 2019
-
Move JSON splitting from Rake to Gulp
Replace the `split_api_json` Rake task with equivalent logic in `gulpfile.js`, so that `npm run gulp` continues to provide the end-to-end build process.
Configuration menu - View commit details
-
Copy full SHA for 42c10c6 - Browse repository at this point
Copy the full SHA 42c10c6View commit details -
Configuration menu - View commit details
-
Copy full SHA for 8595b00 - Browse repository at this point
Copy the full SHA 8595b00View commit details -
Fix "stdout maxBuffer exceeded" error when building site
Prior to this change, the the 'nanoc:compile' gulp task attempted to store the complete output of `nanoc:compile` in a string, which resulted in a "stdout maxBuffer exceeded" error. By using `spawn` instead of `exec`, we can pipe the output of `bundle exec nanoc compile` to STDIO and thus avoid trying to fit it all in a string. Example build failure: https://travis-ci.org/atom/flight-manual.atom.io/builds/550937870#L3656
Configuration menu - View commit details
-
Copy full SHA for 98f177e - Browse repository at this point
Copy the full SHA 98f177eView commit details -
Configuration menu - View commit details
-
Copy full SHA for 3d25e59 - Browse repository at this point
Copy the full SHA 3d25e59View commit details -
Signal completion of "extract_api_docs_data" task
Fixes the error seen at https://travis-ci.org/atom/flight-manual.atom.io/builds/550959348#L7116
Configuration menu - View commit details
-
Copy full SHA for 76a088c - Browse repository at this point
Copy the full SHA 76a088cView commit details
Commits on Jun 27, 2019
-
Avoid long periods of no output from
run_proofer
taskPrior to this change, we were getting the following failure on CI: > No output has been received in the last 10m0s, this potentially > indicates a stalled build or something wrong with the build itself. > ... > The build has been terminated This was due to the `run_proofer` task running for more than 10 minutes with no output. To prevent that situation, this commit introduces two changes: 1. Split up the proofer work. Invoke HTMLProofer on each directory separately, so that the `run_proofer` task reports intermediate progress. Instead of waiting until _all_ directories have been proofed before outputting any results, it will now output results for each directory immediately after proofing that directory. 2. Don't run HTMLProofer on the API docs. Checking all external links for all versions of the API docs would likely take a l-o-n-g time. I don't think we want our builds taking that long. If we _do_ want to run the proofer on all versions of the API docs, perhaps it could happen as part of a nightly build, as opposed to happening on every push. Example build failure: https://travis-ci.org/atom/flight-manual.atom.io/builds/550971951#L7122
Configuration menu - View commit details
-
Copy full SHA for 22558dd - Browse repository at this point
Copy the full SHA 22558ddView commit details -
Merge pull request #537 from atom/jr/api-docs
Enhance build to process API JSON files for Atom 1.0.0 and newer
Configuration menu - View commit details
-
Copy full SHA for 2c08ae9 - Browse repository at this point
Copy the full SHA 2c08ae9View commit details -
Configuration menu - View commit details
-
Copy full SHA for 399c712 - Browse repository at this point
Copy the full SHA 399c712View commit details -
Linkify instance property names
Co-authored-by: Antonio Scandurra <[email protected]>
Configuration menu - View commit details
-
Copy full SHA for 189c8bd - Browse repository at this point
Copy the full SHA 189c8bdView commit details -
Toggle display of instance property description onclick
Co-Authored-By: Antonio Scandurra <[email protected]>
Configuration menu - View commit details
-
Copy full SHA for a9df28e - Browse repository at this point
Copy the full SHA a9df28eView commit details -
Honor URL hash to display instance property description
Co-Authored-By: Antonio Scandurra <[email protected]>
Configuration menu - View commit details
-
Copy full SHA for 8e119a3 - Browse repository at this point
Copy the full SHA 8e119a3View commit details -
Linkify method names and toggle details onclick
Co-Authored-By: Antonio Scandurra <[email protected]>
Configuration menu - View commit details
-
Copy full SHA for 6cdbad6 - Browse repository at this point
Copy the full SHA 6cdbad6View commit details -
Note: The code samples emitted by this change are not yet rendered with syntax highlighted.
Configuration menu - View commit details
-
Copy full SHA for 4649175 - Browse repository at this point
Copy the full SHA 4649175View commit details -
Fix the HTMLProofer build failures
This reverts commit 22558dd and adopts an alternative approach to the problem. We continue to *NOT* run the link checker on the API docs (for the reasons described in the commit messages for 22558dd), but we run the HTMLProofer on the root of the output directory, so that internal links can be properly resolved.
Configuration menu - View commit details
-
Copy full SHA for 5dfe19b - Browse repository at this point
Copy the full SHA 5dfe19bView commit details
Commits on Jul 1, 2019
-
Begin populating search index with API docs
With these changes, we populate the search index with all instance methods present in the latest version of Atom. Next up, we'll need to add classes, class methods, and instance properties to the search index. Co-Authored-By: Antonio Scandurra <[email protected]>
Configuration menu - View commit details
-
Copy full SHA for aeee307 - Browse repository at this point
Copy the full SHA aeee307View commit details -
Fix URL to API docs in search index
Co-Authored-By: Antonio Scandurra <[email protected]>
Configuration menu - View commit details
-
Copy full SHA for 74475a7 - Browse repository at this point
Copy the full SHA 74475a7View commit details -
Configuration menu - View commit details
-
Copy full SHA for b0526cd - Browse repository at this point
Copy the full SHA b0526cdView commit details -
Configuration menu - View commit details
-
Copy full SHA for fb77ad9 - Browse repository at this point
Copy the full SHA fb77ad9View commit details -
Configuration menu - View commit details
-
Copy full SHA for 4599da9 - Browse repository at this point
Copy the full SHA 4599da9View commit details -
Configuration menu - View commit details
-
Copy full SHA for 0a417a8 - Browse repository at this point
Copy the full SHA 0a417a8View commit details -
Configuration menu - View commit details
-
Copy full SHA for f3cc52e - Browse repository at this point
Copy the full SHA f3cc52eView commit details -
Configuration menu - View commit details
-
Copy full SHA for 4685379 - Browse repository at this point
Copy the full SHA 4685379View commit details
Commits on Jul 2, 2019
-
Configuration menu - View commit details
-
Copy full SHA for 4a78c06 - Browse repository at this point
Copy the full SHA 4a78c06View commit details -
Configuration menu - View commit details
-
Copy full SHA for 8416455 - Browse repository at this point
Copy the full SHA 8416455View commit details -
Configuration menu - View commit details
-
Copy full SHA for 387eeee - Browse repository at this point
Copy the full SHA 387eeeeView commit details -
Add helpful redirects for API-related paths
- Redirect `/api` to `/api/latest` - Redirect `/api/latest` to the latest version of the API docs - Redirect `/api/<some-version>` to `/api/<some-version>/AtomEnvironment` This is fully functional, but there are a handful of TODO items that I want to address in some follow-up commits to tidy things up. 😇
Configuration menu - View commit details
-
Copy full SHA for b8b8986 - Browse repository at this point
Copy the full SHA b8b8986View commit details -
Configuration menu - View commit details
-
Copy full SHA for 7ece9a2 - Browse repository at this point
Copy the full SHA 7ece9a2View commit details -
Configuration menu - View commit details
-
Copy full SHA for 3451c8d - Browse repository at this point
Copy the full SHA 3451c8dView commit details -
Configuration menu - View commit details
-
Copy full SHA for de1e02a - Browse repository at this point
Copy the full SHA de1e02aView commit details -
Configuration menu - View commit details
-
Copy full SHA for 2bcdb3c - Browse repository at this point
Copy the full SHA 2bcdb3cView commit details
Commits on Jul 3, 2019
-
Configuration menu - View commit details
-
Copy full SHA for 355e99c - Browse repository at this point
Copy the full SHA 355e99cView commit details -
1
Configuration menu - View commit details
-
Copy full SHA for 566ae12 - Browse repository at this point
Copy the full SHA 566ae12View commit details -
1
Configuration menu - View commit details
-
Copy full SHA for c6f7905 - Browse repository at this point
Copy the full SHA c6f7905View commit details -
1
Configuration menu - View commit details
-
Copy full SHA for b521ac6 - Browse repository at this point
Copy the full SHA b521ac6View commit details
Commits on Jul 4, 2019
-
Fix compilation of non-API pages
Co-Authored-By: Jason Rudolph <[email protected]>
Configuration menu - View commit details
-
Copy full SHA for ba691d3 - Browse repository at this point
Copy the full SHA ba691d3View commit details
Commits on Jul 5, 2019
-
Honor selected version during search
Antonio Scandurra committedJul 5, 2019 Configuration menu - View commit details
-
Copy full SHA for d8470a0 - Browse repository at this point
Copy the full SHA d8470a0View commit details -
Keep URL up to date when user selects a new version in the search page
Antonio Scandurra committedJul 5, 2019 Configuration menu - View commit details
-
Copy full SHA for b14caf0 - Browse repository at this point
Copy the full SHA b14caf0View commit details -
Antonio Scandurra committed
Jul 5, 2019 Configuration menu - View commit details
-
Copy full SHA for 373fa93 - Browse repository at this point
Copy the full SHA 373fa93View commit details -
Redirect to the versioned API page when selecting a new version
Antonio Scandurra committedJul 5, 2019 Configuration menu - View commit details
-
Copy full SHA for 9c457cd - Browse repository at this point
Copy the full SHA 9c457cdView commit details -
Render TOC based on the selected version when viewing an API page
Antonio Scandurra committedJul 5, 2019 Configuration menu - View commit details
-
Copy full SHA for ccef5c1 - Browse repository at this point
Copy the full SHA ccef5c1View commit details
Commits on Jul 15, 2019
-
Move API docs functionality from search.js to api-docs.js
Antonio Scandurra committedJul 15, 2019 1Configuration menu - View commit details
-
Copy full SHA for b3e6add - Browse repository at this point
Copy the full SHA b3e6addView commit details -
Label "Public" classes as "Essential"
Prior to this change, "Public" classes were labeled as "Public", which differs from the behavior on atom.io. See screenshot: https://user-images.githubusercontent.com/2988/60625837-f0bc6d00-9db6-11e9-83f4-0e78c12d96cb.png This commit resolves that discrepancy. "Public" classes will now be labeled as "Essential".
Configuration menu - View commit details
-
Copy full SHA for 60234aa - Browse repository at this point
Copy the full SHA 60234aaView commit details -
Add label to denote optional arguments
Prior to this change, the rendered docs didn't indicate which arguments were optional. This differed from the behavior on atom.io. See https://user-images.githubusercontent.com/2988/60625840-f1550380-9db6-11e9-821c-d75d31511e15.png This commit resolves that discrepancy. Optional arguments will now have an "optional" badge.
Configuration menu - View commit details
-
Copy full SHA for 5a0f390 - Browse repository at this point
Copy the full SHA 5a0f390View commit details
Commits on Jul 16, 2019
-
Add syntax highlighting for code examples in API docs
Co-Authored-By: Jason Rudolph <[email protected]>
Configuration menu - View commit details
-
Copy full SHA for 73b0e94 - Browse repository at this point
Copy the full SHA 73b0e94View commit details -
Start on grouping methods by their visibility
Co-Authored-By: Jason Rudolph <[email protected]>
Configuration menu - View commit details
-
Copy full SHA for 01d81c7 - Browse repository at this point
Copy the full SHA 01d81c7View commit details -
Configuration menu - View commit details
-
Copy full SHA for 128cf11 - Browse repository at this point
Copy the full SHA 128cf11View commit details -
Configuration menu - View commit details
-
Copy full SHA for 1625298 - Browse repository at this point
Copy the full SHA 1625298View commit details -
Configuration menu - View commit details
-
Copy full SHA for f568383 - Browse repository at this point
Copy the full SHA f568383View commit details -
Configuration menu - View commit details
-
Copy full SHA for 0b7fde1 - Browse repository at this point
Copy the full SHA 0b7fde1View commit details -
Configuration menu - View commit details
-
Copy full SHA for f6c1ff9 - Browse repository at this point
Copy the full SHA f6c1ff9View commit details
Commits on Jul 17, 2019
-
Don't hard-wrap when encountering newlines
With the introduction of kramdown in 73b0e94, we started interpreting newline characters as hard wraps, which was causing paragraphs to not take advantage of all the available screen real estate. Documentation is usually hard-wrapped for readability purposes when navigating source code, but those concerns don't apply when viewing the same documentation in a web browser. This commit fixes the visual glitch illustrated above by supplying `hard_wrap: false` to kramdown-gfm. I verified that this doesn't affect the rendering of other markdown constructs such as code block syntax highlighting.
Antonio Scandurra committedJul 17, 2019 Configuration menu - View commit details
-
Copy full SHA for b4c3dc0 - Browse repository at this point
Copy the full SHA b4c3dc0View commit details -
Replace input type from "search" to "text"
This ensures that Safari doesn't apply a custom style that prevents the text box from being displayed correctly.
Antonio Scandurra committedJul 17, 2019 Configuration menu - View commit details
-
Copy full SHA for 9f85a96 - Browse repository at this point
Copy the full SHA 9f85a96View commit details -
Configuration menu - View commit details
-
Copy full SHA for 1ec6b44 - Browse repository at this point
Copy the full SHA 1ec6b44View commit details -
4
Configuration menu - View commit details
-
Copy full SHA for 47cbabf - Browse repository at this point
Copy the full SHA 47cbabfView commit details -
Configuration menu - View commit details
-
Copy full SHA for 92981c2 - Browse repository at this point
Copy the full SHA 92981c2View commit details
Commits on Jul 25, 2019
-
Configuration menu - View commit details
-
Copy full SHA for 9ee89a4 - Browse repository at this point
Copy the full SHA 9ee89a4View commit details -
Configuration menu - View commit details
-
Copy full SHA for 7b48541 - Browse repository at this point
Copy the full SHA 7b48541View commit details