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

FAQ #2765

Open
rubberduck203 opened this Issue Mar 1, 2017 · 2 comments

Comments

Projects
None yet
3 participants
@rubberduck203
Member

rubberduck203 commented Mar 1, 2017

Create an FAQ from the links referenced in #2762.
These questions arise frequently and the info is all available, but doesn't seem to be quite visible enough. Then make it "big & visible".

  • Create FAQ in the Wiki
  • Add section in the ReadMe that links to it.
  • Add link to it in the website?
  • Add it to the about dialog?
@Vogel612

This comment has been minimized.

Show comment
Hide comment
@Vogel612

Vogel612 Nov 26, 2017

Member

Not sure that the Repo Wiki is the right place for this.

The repo wiki might be better off as "internal" documentation, with "user documentation" done on the Website... Opinions @rubberduck-vba/dev ?

Member

Vogel612 commented Nov 26, 2017

Not sure that the Repo Wiki is the right place for this.

The repo wiki might be better off as "internal" documentation, with "user documentation" done on the Website... Opinions @rubberduck-vba/dev ?

@retailcoder

This comment has been minimized.

Show comment
Hide comment
@retailcoder

retailcoder Nov 26, 2017

Member

There were talks of using xml-docs in the source code to generate the user documentation contents. I think that's the best way to do it. Needs quite a bit of work on the RD-Web repo then, and proper & complete xml-doc on all inspections, quickfixes, refactorings,... And basically all commands.

Member

retailcoder commented Nov 26, 2017

There were talks of using xml-docs in the source code to generate the user documentation contents. I think that's the best way to do it. Needs quite a bit of work on the RD-Web repo then, and proper & complete xml-doc on all inspections, quickfixes, refactorings,... And basically all commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment