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

[all plugins] Improve documentation of configuration and usage #127

Open
rajgoel opened this issue Aug 9, 2021 · 2 comments
Open

[all plugins] Improve documentation of configuration and usage #127

rajgoel opened this issue Aug 9, 2021 · 2 comments

Comments

@rajgoel
Copy link
Owner

rajgoel commented Aug 9, 2021

Please report any ambiguities and difficulties with the current documentation here.

@Ouch1978
Copy link

Hi @rajgoel

According to the README.md of Seminar plugin

It says:

Reveal.initialize({
  // ...
	seminar: {
		server: 'https://reveal-seminar.herokuapp.com', // change server as necessary
		room: 'Some room name', // put your room name here
		hash: '$2a$05$hhgakVn1DWBfgfSwMihABeYToIBEiQGJ.ONa.HWEiNGNI6mxFCy8S', // a hash is required for every seminar room and can be generated on the URL of the socket.io server
		autoJoin: true // set to true to auto,matically join the seminar room
	},
  // ...
	plugins: [ RevealChart, RevealSeminar, RevealChalkboard, RevealPoll, RevealQuestions  ]
	// check the respective documentation for the configurations of the other plugins
});

But according to the sample code.

It should be RevealQnA rather than RevealQuestions.

@rajgoel
Copy link
Owner Author

rajgoel commented Aug 30, 2021

@Ouch1978 Thanks a lot, just fixed. Please also consider creating a new issue or pull request for obvious bugs in the future.

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

No branches or pull requests

2 participants