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

Small Update to Docs #621

Merged
merged 2 commits into from
Aug 25, 2023
Merged

Small Update to Docs #621

merged 2 commits into from
Aug 25, 2023

Conversation

confused-Techie
Copy link
Member

This PR started out of the need/want to create a flow chart of the logic of Pulsar as a whole, to remove the need to go trawling through the source code to find who initializes what, when. While the included documents don't totally solve this problem, in my opinion it does help considerable.

I've added two new documents here:

  • overview: Covers the starting up of Pulsar, as well as what important variables are being set where
  • the-world: Covers which modules initialize other modules during startup of 'The World' (AtomEnvironment). Helping to keep the full structure within Pulsar, easily and readily available.

The tools to create these charts are open source, freely available, and have online editors, ensuring anyone on the team is easily able to update them as needed.

Lastly, within the ./docs/README.md I noticed most of the links were totally broken after the sunset, so those have been updated, as well as adding links to the new documents I've added.

I know the written content isn't perfect, but really my goal was to include the charts, and some other slightly helpful info.

@confused-Techie
Copy link
Member Author

With how helpful these docs are, and how often I reference them, and without any reviews stating otherwise I'll go ahead and merge this one.

@confused-Techie confused-Techie merged commit 09bcf01 into master Aug 25, 2023
@confused-Techie confused-Techie deleted the minor-docs-updates branch August 25, 2023 00:00
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.

1 participant