Skip to content
This repository has been archived by the owner on Jun 3, 2022. It is now read-only.

Documentation overhaul #4

Open
Arlodotexe opened this issue Oct 4, 2018 · 0 comments
Open

Documentation overhaul #4

Arlodotexe opened this issue Oct 4, 2018 · 0 comments
Assignees
Labels
todo Something that needs to be done

Comments

@Arlodotexe
Copy link
Owner

Arlodotexe commented Oct 4, 2018

The documentation for Windows-Interact is getting very long and needs to be split up into multiple files under a ./docs/ folder (specifically named this for both docs generation and GitHub Pages)

The plan is to use docute to generate a no-hassle website from the markdown files.

The documentation will be split up by property and sub-property and the methods of each property will be on their own page. This is to adhere to the 'URL is the API.' format used by docute.

Example:

/prop/       => /foo.md ( Win.prop || Win.prop() )
/prop/method => /foo/method.md ( Win.prop.method() )

In order to cover all bases and to leave room for future info, things like Win.set.audioDevices.input or other multi-level nested properties, each nested property will have its own md file with general descriptions of the child properties, even if it does not have any methods.

When it is finally merged into master, the page will automatically be processed by GitHub Pages and picked be available at https://arlodotexe.github.io/windows-interact/, and will also be digested into my own https://arlo.site/

@Arlodotexe Arlodotexe added the todo Something that needs to be done label Oct 4, 2018
@Arlodotexe Arlodotexe self-assigned this Oct 4, 2018
@Arlodotexe Arlodotexe changed the title Split up documentation Documentation overhaul Oct 4, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
todo Something that needs to be done
Projects
None yet
Development

No branches or pull requests

1 participant