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

Documentation reorg #1119

Open
jason0x43 opened this issue Mar 11, 2020 · 1 comment
Open

Documentation reorg #1119

jason0x43 opened this issue Mar 11, 2020 · 1 comment
Assignees
Labels
domain-documentation Related to Intern's documentation effort-low Should be pretty quick priority-medium This should get done, but it's not a high priority

Comments

@jason0x43
Copy link
Member

Reorganize the existing documentation in the Intern repo. The goal of this issue isn't to substantially rewrite or add documentation (not all of the topics in the example below exist yet), but to reorganize and prune the existing docs in preparation for future updates.

See #1088 for discussion.

The overall structure should end up like:

  • Getting Started
    • Installing
    • Unit testing (the basics of writing unit tests for Node and browsers)
    • WebDriver testing (the basics of Intern's WebDriver API)
    • Running Intern (cli and browser client, environments, watch mode)
  • Guides
    • Command line options
    • Configuration
    • Code coverage
    • Using with Babel
    • Using with TypeScript
    • Using with ES modules
    • Mocking
    • ...
  • API

Documentation will still be kept in the docs/ directory in the repo. The overall table of contents should remain in the README; currently it's in a "More Information" section, which should be renamed to "Documentation".

Within the docs directory, individual topics should generally be one per file. If a group of related topics are short, or it makes sense for them to be read continuously, they can go in one file. The "getting started" topics should probably be in the doc root, the guides can go in a "guides" subdirectory, and API docs can go in an "api" subdirectory.

@jason0x43 jason0x43 added domain-documentation Related to Intern's documentation effort-low Should be pretty quick priority-medium This should get done, but it's not a high priority labels Mar 11, 2020
@msssk
Copy link
Contributor

msssk commented Mar 13, 2020

working on this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
domain-documentation Related to Intern's documentation effort-low Should be pretty quick priority-medium This should get done, but it's not a high priority
Projects
None yet
Development

No branches or pull requests

2 participants