Skip to content

Show the documentation structure #248

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

Merged
merged 4 commits into from
Jan 31, 2023
Merged

Show the documentation structure #248

merged 4 commits into from
Jan 31, 2023

Conversation

akaszynski
Copy link
Contributor

Show the documentation structure in structure.rst.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jan 30, 2023
@akaszynski
Copy link
Contributor Author

@jorgepiloto, if you agree, please add AUTHORS.md to https://github.com/ansys/ansys-templates/

@phxnsharp
Copy link

I'm still philosophically working though this one in my head. At Ansys we create products and libraries that are much bigger than individual contributors. Projects should always be done from the perspective that new people will be taking them over, and probably relatively quickly. This encourages sustainable documentation. An author list can be a crutch for not writing proper documentation.

For example, ansys-common-variableinterop was written by a 5 person team and might during any sprint be worked on by another team of similar size. An author list would be long from the start, and unwieldy quickly. Besides, GitHub already keeps track of who contributes for us.

@jorgepiloto
Copy link
Member

Thanks for enhancing this, @akaszynski.

Your answer got me thinking, @phxnsharp and I decided to open this disucussion so we can agree about the usage and content of the AUTHORS file. The discussion presents some exmaples from the GNU project and Google.

@jorgepiloto jorgepiloto merged commit 5764dff into main Jan 31, 2023
@jorgepiloto jorgepiloto deleted the doc/show-doc-structure branch January 31, 2023 06:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants