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

Document undocumented settings #332

Merged

Conversation

datho7561
Copy link
Contributor

Adding the updates to the wiki into the internal documentation, then adding links from the undocumented settings into the settings.

Closes #328

@datho7561 datho7561 force-pushed the 328-undocumented-settings branch 5 times, most recently from 5ed0bc1 to 33ac585 Compare September 24, 2020 18:30
@datho7561 datho7561 marked this pull request as ready for review September 24, 2020 20:31
docs/Validation.md Outdated Show resolved Hide resolved
docs/Preferences.md Outdated Show resolved Hide resolved
docs/Preferences.md Outdated Show resolved Hide resolved
@datho7561 datho7561 force-pushed the 328-undocumented-settings branch 2 times, most recently from 3121949 to 178e95a Compare September 28, 2020 15:36
package.json Outdated Show resolved Hide resolved
docs/CodeLens.md Outdated Show resolved Hide resolved
@datho7561 datho7561 force-pushed the 328-undocumented-settings branch 4 times, most recently from 7343276 to 039e1bd Compare September 28, 2020 18:31
package.json Outdated Show resolved Hide resolved
docs/Formatting.md Outdated Show resolved Hide resolved
docs/Formatting.md Outdated Show resolved Hide resolved
@datho7561 datho7561 force-pushed the 328-undocumented-settings branch from 039e1bd to d628440 Compare September 29, 2020 15:05
@datho7561
Copy link
Contributor Author

Still needs some for. For instance, the link from Preferences.md to Formatting.md doesn't work.

@datho7561
Copy link
Contributor Author

My replacement strategy assumes that cross page links all have a section. This means [go to this other page](OtherPage) doesn't work. However, since every page has a title, we can link to the title for the page ([go to this page](OtherPage#other-page-title).

@datho7561 datho7561 force-pushed the 328-undocumented-settings branch from 70253f7 to dc48033 Compare October 1, 2020 13:58
@datho7561 datho7561 requested a review from angelozerr October 1, 2020 13:59
@angelozerr
Copy link
Contributor

My replacement strategy assumes that cross page links all have a section. This means go to this other page doesn't work. However, since every page has a title, we can link to the title for the page (go to this page.

It sounds good, could you add a comment about that please.

Add new documentation from the wiki.
Add links to new documentation in the settings section of `package.json`
Links between document pages are replaced during runtime so that
they work property with vscode.

Closes redhat-developer#328

Signed-off-by: David Thompson <[email protected]>
@datho7561 datho7561 force-pushed the 328-undocumented-settings branch from dc48033 to dfcb7ec Compare October 1, 2020 18:13
@angelozerr angelozerr merged commit b44ceb9 into redhat-developer:master Oct 2, 2020
@angelozerr
Copy link
Contributor

Great job @datho7561 !

@datho7561 datho7561 deleted the 328-undocumented-settings branch January 18, 2021 19:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add XML documentation for settings which have no documentation
2 participants